From 99086d4b51e59f381ea68f90d1fe3d1b12e71f87 Mon Sep 17 00:00:00 2001 From: Aleksandr Soloshenko Date: Mon, 13 Nov 2023 00:24:05 +0700 Subject: [PATCH] Added: static pages by MkDocs --- .dockerignore | 1 + LICENSE | 201 ++++++++++++++++++ Makefile | 11 +- api/requests.http | 24 ++- build/package/Dockerfile | 14 +- deployments/docker-compose/docker-compose.yml | 45 ++++ internal/config/config.go | 12 +- internal/sms-gateway/handlers/root.go | 2 +- web/mkdocs/.dockerignore | 2 + web/mkdocs/.gitignore | 2 + web/mkdocs/docs/api.md | 7 + web/mkdocs/docs/contributing.md | 12 ++ web/mkdocs/docs/favicon.ico | Bin 0 -> 67646 bytes web/mkdocs/docs/getting-started.md | 31 +++ web/mkdocs/docs/index.md | 43 ++++ web/mkdocs/docs/installation.md | 18 ++ web/mkdocs/docs/license.md | 201 ++++++++++++++++++ web/{static/images => mkdocs/docs}/logo.png | Bin web/mkdocs/docs/pricing.md | 9 + web/mkdocs/mkdocs.yml | 22 ++ web/static/getting-started.html | 28 --- web/static/index.html | 62 ------ web/static/styles.css | 40 ---- 23 files changed, 643 insertions(+), 144 deletions(-) create mode 100644 .dockerignore create mode 100644 LICENSE create mode 100644 deployments/docker-compose/docker-compose.yml create mode 100644 web/mkdocs/.dockerignore create mode 100644 web/mkdocs/.gitignore create mode 100644 web/mkdocs/docs/api.md create mode 100644 web/mkdocs/docs/contributing.md create mode 100644 web/mkdocs/docs/favicon.ico create mode 100644 web/mkdocs/docs/getting-started.md create mode 100644 web/mkdocs/docs/index.md create mode 100644 web/mkdocs/docs/installation.md create mode 100644 web/mkdocs/docs/license.md rename web/{static/images => mkdocs/docs}/logo.png (100%) create mode 100644 web/mkdocs/docs/pricing.md create mode 100644 web/mkdocs/mkdocs.yml delete mode 100644 web/static/getting-started.html delete mode 100644 web/static/index.html delete mode 100644 web/static/styles.css diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..4032ec6 --- /dev/null +++ b/.dockerignore @@ -0,0 +1 @@ +.git/ \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f49a4e1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/Makefile b/Makefile index 39dde5f..7a840ae 100644 --- a/Makefile +++ b/Makefile @@ -35,6 +35,12 @@ build: install: go install ./cmd/$(project_name) +docker-build: + docker build -f build/package/Dockerfile -t $(image_name) --build-arg APP=$(project_name) . + +docker: + docker-compose -f deployments/docker-compose/docker-compose.yml up --build + docker-dev: docker-compose -f deployments/docker-compose/docker-compose.dev.yml up --build @@ -45,4 +51,7 @@ api-docs: view-docs: php -S 127.0.0.1:8080 -t ./api -.PHONY: init init-dev air run test install api-docs docker-dev view-docs \ No newline at end of file +clean: + docker-compose -f deployments/docker-compose/docker-compose.yml down --volumes + +.PHONY: init init-dev air run test install docker docker-build api-docs docker-dev view-docs clean \ No newline at end of file diff --git a/api/requests.http b/api/requests.http index 057bccf..548e518 100644 --- a/api/requests.http +++ b/api/requests.http @@ -1,3 +1,4 @@ +@localUrl=http://localhost:8080 @baseUrl=http://localhost:3000 ### @@ -12,20 +13,33 @@ Content-Type: application/json ### POST {{baseUrl}}/api/3rdparty/v1/message HTTP/1.1 Content-Type: application/json -Authorization: Basic IUGFXE:v4ejpbeydvjo1h +Authorization: Basic RMTJTU:yv3sqcidpqeoxc { "message": "Test", - "ttl": {{$randomInt 0 86400}}, + "ttl": 600, "phoneNumbers": [ "79990001234" ] } ### -GET {{baseUrl}}/api/3rdparty/v1/message/pRl1wf_yez5TikJb_xemU HTTP/1.1 -Authorization: Basic IUGFXE:v4ejpbeydvjo1h +GET {{baseUrl}}/api/3rdparty/v1/message/HE9_eR12bfUauavjvgS1O HTTP/1.1 +Authorization: Basic RMTJTU:yv3sqcidpqeoxc ### GET {{baseUrl}}/api/mobile/v1/message HTTP/1.1 -Authorization: Bearer KuvE4LBXzvy8QO2ZXDDMP \ No newline at end of file +Authorization: Bearer KuvE4LBXzvy8QO2ZXDDMP + +### +POST {{localUrl}}/message HTTP/1.1 +Content-Type: application/json +Authorization: Basic sms:6jH2vwEA + +{ + "message": "Test", + "ttl": 600, + "phoneNumbers": [ + "+79990001234" + ] +} \ No newline at end of file diff --git a/build/package/Dockerfile b/build/package/Dockerfile index 4fd5e9c..a9a47d0 100644 --- a/build/package/Dockerfile +++ b/build/package/Dockerfile @@ -19,6 +19,18 @@ COPY . . # RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -installsuffix cgo -o app . RUN CGO_ENABLED=0 go build -a -installsuffix cgo -o app ./cmd/${APP}/main.go +# Build MkDocs +FROM squidfunk/mkdocs-material AS mkdocs + +WORKDIR /docs + +RUN pip install mkdocs-render-swagger-plugin + +COPY web/mkdocs . + +RUN mkdocs build + + # Moving the binary to the 'final Image' to make it smaller FROM alpine:3 as prod @@ -31,7 +43,7 @@ COPY --from=build /go/bin/goose /app/goose COPY scripts/docker-entrypoint.sh /docker-entrypoint.sh -# `boilerplate` should be replaced here as well +COPY --from=mkdocs /docs/site /app/static COPY db/migrations /app/migrations COPY --from=build /go/src/app /app diff --git a/deployments/docker-compose/docker-compose.yml b/deployments/docker-compose/docker-compose.yml new file mode 100644 index 0000000..dee1325 --- /dev/null +++ b/deployments/docker-compose/docker-compose.yml @@ -0,0 +1,45 @@ +version: '3' +services: + backend: + image: capcom6/sms-gateway + build: + context: ../.. + dockerfile: ./build/package/Dockerfile + args: + - APP=sms-gateway + environment: + - DEBUG=1 + - CONFIG_PATH=config.yml + - GOOSE_DBSTRING=sms:sms@tcp(db:3306)/sms + - HTTP_LISTEN=0.0.0.0:3000 + - DATABASE_HOST=db + - DATABASE_PORT=3306 + - DATABASE_USER=sms + - DATABASE_PASSWORD=sms + - DATABASE_DATABASE=sms + ports: + - "3000:3000" + volumes: + - ../../configs/config.yml:/app/config.yml:ro + restart: 'no' + depends_on: + db: + condition: service_healthy + + db: + image: mariadb:10.6 + environment: + - MYSQL_ROOT_PASSWORD=root + - MYSQL_DATABASE=sms + - MYSQL_USER=sms + - MYSQL_PASSWORD=sms + volumes: + - mariadb-data:/var/lib/mysql + restart: 'no' + healthcheck: + test: ["CMD", "mysqladmin", "ping", "-proot", "-h", "127.0.0.1"] + timeout: 5s + retries: 10 + +volumes: + mariadb-data: \ No newline at end of file diff --git a/internal/config/config.go b/internal/config/config.go index 78861c2..8af7c81 100644 --- a/internal/config/config.go +++ b/internal/config/config.go @@ -16,15 +16,15 @@ type Config struct { } type HTTP struct { - Listen string `yaml:"listen"` + Listen string `yaml:"listen" env:"HTTP_LISTEN"` } type Database struct { - Host string `yaml:"host"` - Port int `yaml:"port"` - User string `yaml:"user"` - Password string `yaml:"password"` - Database string `yaml:"database"` + Host string `yaml:"host" env:"DATABASE_HOST"` + Port int `yaml:"port" env:"DATABASE_PORT"` + User string `yaml:"user" env:"DATABASE_USER"` + Password string `yaml:"password" env:"DATABASE_PASSWORD"` + Database string `yaml:"database" env:"DATABASE_DATABASE"` } type FCMConfig struct { diff --git a/internal/sms-gateway/handlers/root.go b/internal/sms-gateway/handlers/root.go index 6a09707..6740485 100644 --- a/internal/sms-gateway/handlers/root.go +++ b/internal/sms-gateway/handlers/root.go @@ -8,7 +8,7 @@ type rootHandler struct { } func (h *rootHandler) Register(app *fiber.App) { - app.Static("/", "web/static") + app.Static("/", "static") } func newRootHandler() *rootHandler { diff --git a/web/mkdocs/.dockerignore b/web/mkdocs/.dockerignore new file mode 100644 index 0000000..bc4b8ed --- /dev/null +++ b/web/mkdocs/.dockerignore @@ -0,0 +1,2 @@ +venv/ +site/ \ No newline at end of file diff --git a/web/mkdocs/.gitignore b/web/mkdocs/.gitignore new file mode 100644 index 0000000..c2679e3 --- /dev/null +++ b/web/mkdocs/.gitignore @@ -0,0 +1,2 @@ +venv/ +site/ diff --git a/web/mkdocs/docs/api.md b/web/mkdocs/docs/api.md new file mode 100644 index 0000000..ff1c6cd --- /dev/null +++ b/web/mkdocs/docs/api.md @@ -0,0 +1,7 @@ +# API + +The Android SMS Gateway provides an API that allows you to send SMS messages programmatically from your own applications or services. + +You can find the OpenAPI specification for our API at the following link: [OpenAPI Specification](https://capcom6.github.io/android-sms-gateway/). This specification includes detailed information about the available endpoints, request/response structure, and more. + +Feel free to explore it for better understanding and integration with our service. \ No newline at end of file diff --git a/web/mkdocs/docs/contributing.md b/web/mkdocs/docs/contributing.md new file mode 100644 index 0000000..bf269e7 --- /dev/null +++ b/web/mkdocs/docs/contributing.md @@ -0,0 +1,12 @@ +## Contributing + +Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. + +If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". +Don't forget to give the project a star! Thanks again! + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the Branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request \ No newline at end of file diff --git a/web/mkdocs/docs/favicon.ico b/web/mkdocs/docs/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..6450680960d67289e94726ccd5ee883d92402690 GIT binary patch literal 67646 zcmeHwXLlAywyw{&`wPzJ`|+%GCmqk&V;h?sC32Dk3WzLnP9oKIpaLG zaR7|Lm}r8DN(is#KD(;-+ok4J00S0SGi!TS*j2CSXQ!&J?tbHq|Kk70j(vmw{l9Pg z&;R+aH~#yLH{SRk5}Tyav`f)cY$5dDb-5c*MOD|JN(ZWRph^d-bYQI)50sas6G53^ zJvg?!{-AuY{(Hx}^OZN3^p_{&&R1SJIG5Iymo>g3GG&c_mcBK)8%zBAC= zF1f$4)|1gTSI#X5``vl9PusMvkHSe<6SOtZe7dncr7b;WwadRR<`7I6B%h& zuH~}oK^c)%Jfy57a%;RkDZ8XH;ke34U%0Zixm@)`+jMNW`L$1FgWT=c@gk#Tm+M#^ zqkW~xYkyGQZT~%G_jmPgbK7)oZBwp)kJg2kBx{G-A5LE9cKdV=i;uNicMf-qmUWEO z6<6&OuKmj0HZ3c6e@o?+yE3kvwhLF%e&w!=+ZL49y2^{JEAN(7#vM~y*`3Fo!!5gG zOOp@ExOFM(IF|?8-MU+L$GByYDUW>l@cv(XyUMsaqHXTqp}!@4e!D+j`<1(MXq%4H zdTBC2IhB7AT>m}p+~L}^U;pNCGQl>tu4Uoj$}+#UYguIlC&kBaD;xiCbA|gi1n1Mb zE30MYI=9M}Ru_5g3y#%#P$nqv$_2|6m93~;aDJ`Jcz2FqUFAySDz9ASbWXQj+eF4~ zm%8YHk}Ie41-Xt_?)K|=m#ds|k=K458?H~=R93l;3CDFzxW4DzR*}D_qQ6#pppQkH*1MgAQs zqul-XmDW~PyYvOgoikWgUC}rn><>4WwyCVtwJf}>ew9`3j(gS1zvtiNUNd(dZPzyC zdaa)9FFoJVG0NSsT6X(HH>9q8;kfqeIIWAUmfb!rYroe2Og!AbUE72!1+Pi4UF$BF zFcmfb#ArWfU(BpuVi%p+qn_*d&^fgpj*CosMh23)B%oP?8faMkZ8UiQU!;GQqz~S7>MVc2{wL^PsQ&@S zdhPYerEW>&b(|+tooya9{NOGA_FJgW->viRKS+N^-D>|pi^$p-GjdcBB+&`C z&6iPG=Xo_Qtc^C^SFIHQpu(w`Cby_q{g_{KlXamFOlL@Y|5h=u9nu`q2M7N(5C!nw)Fo-+d3vxj5hoMg&Q!tzCFSiNe6 z^({shp3Do~>!#OOx%Nq2N!p~WYe1DLi|c&h;=enu&h5+F-zsbFaD8jnZ@{4by*=zL zrmk%o9T2=c92F;97kQz7n*NBIZzH1Szb(}eE_F-(_HPz@8he}JhyYhYThnwUmDqi=1@>{r)P-#V<5`UusvrpVo+9}Vx~BiCL3(mab>l; zbGqf=n6m0CSFJ{em{yFpZ+ciNrXD`x4-8%oW+B@adwmN{Yrl)u4XUF}!x|pde4^Z{ zelW1io)d#Wfs75u=j`>-;$U11(xHe+Q zg=}5gYxaFXnTX(T`+qGQLc~rhEF8D83{F!qZTto+q9thU1K3JWw zzT4`7^f#gJ@7lHrdd0T#s3m!8zaGbSLoLy{O@zq@{5d$MvHiEG7yrVL`0AL;xIUY< zKbzPKi5`eAFq|0A^vL4x`3ANL{u0N9#21*jK+LTVux-*ll@!8W^}y(W+fJS6CHhhe z3zmh~qKeu0P z%pterl^vZZ5gQ~v&_@Va9Z-E>ZeVo5<_CUR>XJh!RX2X$*9(aUq#iYpHnAtKb#BN% zmv?Q0xG0vv_R{82Ipr#+^GH3|r!r5=ef;VFtNpLHKl7%E1@)@^lWipCypTg4p0wR z4w0u1v#A@iBqkWrIAOV23s6s{8(r}H19iZU8PX>HL45>uppO?DBtA%-5Zf1G3`iLr zkG1QbZO=(Db9s3fx!Ag89j9|iJzT%aRfJpoa}dM)&)`oSA{ozPTScHlR5Op7k~cv@ zR8vxrv#o7Y#MA#9qMgUn?&Hbh9Fn#;A^Lz=LybMI^+4+HAFOM8MY-C)U{UsjMCho#LT^LXYsU%k) z=CIG`gTY?#cZhmXLKjTk(}Pf-_!27@@(spE)I`Rlo><5GU=_WluAJhd-0dr^tg^~g zPU^un?R!?P_(!#jL@n;I_UIIgn>ViGx8Ht4aq;74qQ@Nf_%TU%X=S%xWgh>Av;R4S z`NNwT-=D%fFod~cPd!LwS@2g%89;wvh&n(YAvBvZhQvomK1qLI))W#qLZmuk+h!V{ z!8K{-mt$$tLXJs%#>GTTzMFm*I$v}P#GWp#;CzPx3S5CP>`R8M~{k0 zk6tnrBR}r}4&|mHZ9sz(I*>|CE%~^o5_97R#20upcR)R(3v*aEK7smTxvh&1Xg+Cm zf_mZUit953cku_QBf0*|S^CuLzaU1>f`4!h#q7CqZ~rH{WfRnR`>&WXZUhPo3LM;D zkRB9;pSPHL_u%d=9NV%0*`wM}2Z$$eka%G6uZOgO^^opS+Ca7sq#g)2K7l@idSQHm z$rr>Q2=-PFB#uaKp)p0usvoKc!e@#6;0WGVnEKS%mxfP8@l-kG!TCyS56V@nz7Z>O zauCh@ujbo-!IZJXiGTicw*T;0m*!uJi;Kl#WY?&&P2d1QTp^$QvwTpyv>hvJIsI~;vU8QKhs(nn0rpKE!Trub#m4fPd<4{V6kVJ$F!QWBOgPJ8B@uQWVf zHm;@p9l>_NU)FzO|C5dVyZ+zeT10#c3Ll{`Kt-$@>{SQK)q~RTE?s{lm;C9wkFaQD zQxAK=zaBEE3mJnId*L4b?6W!`en3g^r*1g)ltB%VJ#!Eir;a9#;eF(3Sh*~lYkjWu z7#D-r=~?SfgS*H+jr_CzP5wCR|1JK1CH})a|L^1RAg>6!KYfTLJ0D=-wtJYrcfZVm6DH1EAAt6%YDpQe-HiUJ;Z>_0vtP)kH@9r|Md1A!oNh0ScK2_El2jy z2A&RhK7hEJIAC<44$I694bdMkS1{O%ZV-3DKBNnS8)C`43C}IJD^FjZ#;(i4y{x|S z{)VvqCjaOCKd%2v;&1J-xcCt+UN6AtC3(cU2(#B0;mh-nu;rry3|~};A=!mE{AIpx z{}r+QXYdoEhriyqjFr>7Ad@)GC&rQoWD<813seu-COQzLkWLssQ4b5J_QaaCt1E?_ z2XT4s7?oqE-=X{eQ7yUuBmO^tzxd(@`9;|ANgmQR3FRY| zl)j|^8C&zQ>LBC)%>sk}{d@QE%eCwH<@$Bpxc*Ck{Pz5Z71&==y>WCU@8Ls?9@+=3 z>ii4iy4U4;pdqq|?R?@dYr=U-#NU+3&3b_{nJlLzH^$h^u1MNB36nPeF=xpuf~DfF zydq|cc;F=>2JTsnePI` zw$tB!XZr5mxm)i3Lb!a=;6J1f>herz>#j{PB%>>4jBkl~!x~|}U`?ABJrEL|m@l{w zX@JyG%`j!GFT&lKwxG zi+Oe^xEO3a%x%BbfjrvvjbDOx@7I61_6u(Qa)bNJPp&Uz9+~&nodT@cc>^c^a}W6i zRw0$paoM z5huy_g{++l{#FM{=m-0s*cX!cF1}s*0wg)!W#*b4lP@A>@CAJQ^&Rd3shr~92elce z8h2}sXyPBWVJxCHjYrIuiHO@e5gm3+LB~Ba(CNTzbUKoX#1rY3h zX~@pasg(FD?#f-Ac>ZNw|BL_sOIZ6aBwm+(DZuHA`8X3GSsUc%dpK*%E(PBp-fGuw zyX-UVJbD)`dtb!-HCID=CHJF3_D??**|iy>*Af3*;=j@2-){R9#O|GighMIla5NPi zjja>!6Y~u2f_>r%OI;78W5I^XjsNq=x&OLOWc^6%0 z+(nn^Lidm~^BzWj_yDJVe9HA-!0uiAWq)z!k=uyqd;#-vt~)-$$G;Z!G(z!TPy9EG zNA%{2Xt#~{@0p2&gT!BKpZJF`C-xnPy^!cYm&278|CfWirweBN$NN8$|NWc!U%>y1 z|NZHDA(EHoqsy#3beM7<{nGD~KSa`;LJXW=Xx4uc8(bWprEGrdN*>w|{t40jFW{^1 z@0*xo=d$>ZX8vdJ@6rrWYl;0jQm(~6W~+z)0pfo+4IPe&&-XDG+>H*L%s}TOX~+uL zzvKd|dB0~R^TJi@?Rl@toF6yg^O;Qv=N>e3WZYexI{Z<>gh zt& zSdi;I5B3uC#FrEIOWMEe|JF44m(2eqpSyOu2vb(&qc8XW1`ziNs|zrgdw>11WdA20 zpPbIKb}D!&mEq%kOkI3!SumG;!_WJC85{oe!)ML z_D>)1g#9c2>By%2=W-8dN$zS4+Ckl5-jKjC3Dg_InL~8jHy5)v%ClhMV&{u#d#U*I z->>`s27mhhg24TMx$pPs8LrC?=VQ$gAt@JNEz7$<%fsz^f%`u}9guq1^F+Swm!%WZ zC+9*8{)2ma_AmI4LG&8M-?M+>A5Z)f1plMf|7*_Y`v0!9|An;wH9XgyynQ|rj#6ic zdx*GJ=s-$1k&3R2Ckr;Ltdwho->sL7{}%rywEw@D_;2y|?ap5RBKqSZuE`5<_s$*s zdh3>DAnd-{LD-`YQOKw0-m{_o{|Mh8x&qZ{+TMZ`aw)RlVy##fZU-_r%r zf#WHdux;T>^8qi@{&oLXp8v4+KaBe`;m-f?97bUwZr{9t%RB>o`KKRo$q>&2mnci! zo(aBmfn13F_Kffak854e4m)+u9g@As_KQE5@$ws2c^)}=P%n!=PKY{tbv1POVmz-a9!1C_Ie=)I7*|Z!THCBZ1XP$VBMBNcepbm`KmBst=&vpj* zciZR-jXhrer}00G|F^!m2zO}XS9k{eGV!$}I$-fGn_D?OCvNpYFjw4zTy?Q_%n`s_}lfLVoyCd?&B}^KYR0XBp&8^;aF-Y z_8aU)7bJHuIw1JZe@*eX`+x1)c=?~;AF%&>4+?SW%pDv)@iPt_yNClvg`|9mB>ZRW zKY9uK3|%G{^6E#lu3Xxkew8bQA3k{rr@pz!=LpW@{12xwq;HoJ__yU6pv}5*+yj#Q zPx61y{*6sb{1^Xk*ZgKJNc?3D*zItJ@&B{8EMu&YywAno$pfediR??>N&KJj8Gy=d z|K9$uod2U;O&qQM-^Tx2_X{w8(|yE^x{v7L4-hr%A=(bJ+?0p1ZYU3J$c0)D%_G^e zww2&R*gu4FN@k46%Q((6%u-wOm=XCHl5!U(zr2F;XU|}8pROiO8T-!}#T;M^+O7?Q zzia=rW8DYp;Njnu{$KJx7yoz@>jm$0?j8E}pUC*1yyJDn-}--f{@;)PcK=WE{%^SV zvtVx_S`RNolL19&GLR&Ez#}vk>TfBMJhFcg=@BA?C=;n<`n2E5sC)#+L~tIJm9nW1 zWZS@EG$tRhr~rGuEx@Vo&tq`!t|9x6${9)gM;rX3L-x=7&yD}ahtubKeqY!BU6086 zZ#8CZS<1b_6vp^e#M4&@B^aNdK`tbE@cQF#&i~2!-?M+Y7juR8_4j_4k3;8+F)^nQ z%?Eq<6O$$+gTJQ-kp@G-vDo0JI4bx1MaC!XH<)X?!QSHEX-WZdKQG4aGmo*2ac5vJ z-~X4ue*^vh7Owv#|39etpYH#P&v%IXKV6SxAbTV6-@25!g5aMP!d@^p*fUNfoJb@6 zN$}^sn!%rIyx$%dHGcOc49$ z{?B9L|K*u{v`fB^aXjm_`@3T7qaMuNQiS&7#JBr49KxS%Av_r;Yz)vg9b?<2&nJ_iUeYEU%8NJ5-fS#Q@nfHR3`#<9Uxdt@&^B#cQ18%=N z9R7a(Z*_qCzqJ1a#{QRZpXf>aC2ur3!1ZIo$uzvS_&fVQvj6Ym|26Gja=vB*3ei8c z2x~un#8~hMIVXzHE0y`cAYvx5U9cn9SZ;9?JPX-YKqBv(kA^+(p?>$TiAJABak8+;IT8g;w;f=2y3-SFhwjmyWh_4(NR^&@Qjq7Wl8Z=g}POQ_x9 zGHQ{M#+*fW!T(*spXWbTa{X`c=RUB9zwG}R|1bCdj@tFU-t(1ppz-J2|Le^BPwxNB z+{XAHz~8JHP2Q;Zr(yK2#V`4}j2ClnA-EO|;m_y)1^@A*2Ak)94gNpm6aV`be`3^_ z)N)t>p9Ltu<}YcV%n7o%Ht001!1!!q=VI&qgz{PA0lfXu|HLWC5IlO+oY?g*ZF7E>3A7+IuZZGE5!c?bnhtk|977M z5d6jdNoEgt9AdZ!+@AaYakBqo@VD__)_i8)mpNd9kcWSk;?K2We7N{8wr~7D?SI!I z+W*VJB#6-qtvmkT;6HMR+5b`eqYeJD_ABICj3j(O0lG{rz{0&n#uu#rG#|a^-lI%D zBE_a@^NspEK>f~FP_x|`)M|egwPVkr2K7Mf|NT~^*5A?(oI%rmH!*7211vqBhqa#< zVCMQeh#qnobvs@n?pF-e7W}CPCGqF|pB0S%W(~-D06Yf}!!@AbZ}$JZ`#?R`Lt ze?0wvC;ETEf7aGz-2Y>aulqk<-WS^Y^Wy(&i@)6e2jJr`{$K9vczK+x<%wlH?cd^`j;xKVFo*be=2 z7?yFCXLEm|?cXHkGM>I+b^*FGMzkKvxX`-*^}F0e^KRc^$jnbLKI;<{I557l{4UQt;RKFZj#(PvXCv{+~HO8xQ|z?g9Ds zPkSc*p)){UK9?YRVDL{1;os$;;7=bA!e7eP{$)=%p85alYX719FNDA3e|G(E{Xg+1 z*4F;%2bix#k{WRhSF8Ow#`9Cgm)CB89+646(R@H2dd_@^<%bGz@?tSQyY?GCz51Ks zpI>{76Bi$2@xCH-<-T6afqBgDubMgDY5XzXYyLTE#hovKzxse$9j~E>$^Qg@$^Tjq zfBJvHKgZq&j>(;X*qw6!pZVV*+OVAeko&lyd%27OCJr$EGv?1{{1^Y<$;f*5izQx| zGeCAf(BRKAAR~7zd@cQd5dU!_?fZXB{-^$*csFKVFW8GNL@>9jlW>8!e~p^ar%^xg z8X|i>KE4WyGI3U=V*f|CMk^&i|-Cr+rfgbWJaLKu3fB zO3ar0kNJPXG3tzW_RIPK#siZBP!G8O`zqVNoF}p0lC509j@U07XLxD=AY6J{K!0z`9IfvwHf`2QICf3bfbf9uD^{{1yQ{dx)f?foCK{tMwx8PEUAeF3>QG;-&wm;VXw z8#b)Ro-M0zc>6LO+p(0i3`a@Fb_y-U$z98^XZ?J%Yf<0g@4f#^_kU#nuW`RTYxi8w z*XwfK*lPVwHxSu751l9FaeuY|M=#LV)8>7gALC=<|1oj5Bz;O&7mQD!FW7tf5!Vs< zXv6!$4Z7SyP3l&)=AWTvd+GpjH#$Hc)06wZN!PQ_ zPycUXKXpNJd&%bw{;A01nLc~}XD;Gp56HtmbpF$e0~UXt|9Qpk{~z480v8UZ;_k6& z$U8m}`6nij$WK}-I58fDC&%ORuHi^*@qs!2J#OT{(Eg9z|K<9Rd444KZyR*Kg*x1a zYta1;qRiTl=RdzKqHlL?-ePO97ab519q_rYBc2{GM>t8pk#nqwxkEmhFt?~n`+vXX z=hT677XJ=cx&MD2J-T%9;y?F)mXBck7yNk-Xf5{u`5chq-@)_$YRCRQfan090p$L` ze4hWE&HKLzd^RwS_WbaEW7?HYkjEd_u2|Ku?E)9xE4-Q}9@7WZo&U_cu8YEBm7<4a=mHnv+#gLsSm z`?%Y(Uk|4T2Yx8VjI~@h4!e)~Tnkih`;GAfwTOS83FpwOEAglQm*@Z5$^Ng|0~&=k zV*h*wAZ`zz|MKF0f?3l^&ga>_w+3+WPviNo4u|F?5Z#E#5Y z!v4kQ@7uZ(caBaa#>D)%kH27EXs{n=`if4DCH`Y^ZTE1#yZZyP{uli7^YhI8U%CGm zMI2=RK7#jdx=rKzfA-MVb1i3Zzv9RAk~S{(?qcu906!k6Pf(q)vEfttf{(8}#@dex zxu5h9jeFiQdxtd>f5y-m7tuGVo58-#a^me+PrVUB_Ab z7d?=8kk0&H?0+Q|^B!PVJ}(x3WDbd3a5t2KxMSiIq&^oTx4#ylkcK#=W7_7b{YM9bf^EP{U^0R`}N%O zH_v|Z-1qjW^!+mo{^tA-{lA<6wft6A{=d4H z|M~X+#pwc!$i9p1Ul-uhE5!!;PsHX)zAtxix8;wBUr7?|wawK7okzKh_sgF!H)_u%ad<}#8B=P<~_kW0gyIi^FBlrC$quustCGn?yi~pBB06E)ho&^>BJsprW zf2Q~R&!SDM(QAJ?b%1#Qu{I>}fFwFGc>e+{+w^Sje}AF(Zm7HN{G!X-Hm$`C>T==n zNyJ}tfcP8obm4^L0ICD@3Csnr?iy+0zwG~p;y=%Sow-#ze+-}fmYgqo^JK)({$qDd z_wBy~{`O3#)d7hCV*j%L<3InMy?Hf;?8!nR?;XY-nuAz*Uj(rqx<4C>w^V-YRS!08 zT#w82ZH3JDE&jya;7=bQ-17m2Tn7|!Jy3LF67d)Nm-x^8Z^Qt`|A*#ztA~8=&v`!I z|MhjjoObEaN5ualmP=x-SgH;bvtLN-Dz9AIm2115$Jd3&_=59%aqb~*+`5Mm1ACY} zCBnS_L*l-R|1{z+=fCHecL11Y0Avry>;rkW@2%@Q8vOnDe~52iwIP@9wp)eiTqjT2 zxddt3bC9!%-*T5CzQr3y+BoOhS?2q6gv+ND>>UA4T*LMJFZ`|IrqI zK38w?m-jQ-^WSm~^!CF?`0j@6>B)YMuHjv-?aHN3_kL`f8!yV9LwtbPKjRJk|2H>^ zaf`n%&!Ikia38}5_B8LQeG>m^-20zy^8fh#%;lKVnP&h^3}7r^JWpUOkbEGXI?##h z;^6b&f~R2ZQf0-sw7*MYz|PHUaD(qT66`IB9ylbv!I0wb*+0*Js{IF_*UaZx@L!3; z%?Cc+VEI`|=8>^F-;?tc8QdSrJAgc0d_eq1i2r|^`+wg1f2{wXME^g<;4klgh}+Lx zj%Pq6c8d>)S28&r^E&1O9S@}P{EzSdOS_)0YWp$n_uV-%ojAKXAolO+fwY&ff98K7 z{KLPWP2cVFGPz58*!rS9gv^ zXD|MbPqyd3O4@(LpVRj7^6mCf8SiuqEAQF6+b7R|-@kvK&;KPE{Co9J;`!Yi(n_A= z&q4Mkp;cJOTz(;QxrJMl)|hfO<9asRgcb-xO*f46%@@%SU;)^FH=^9RzcuQ#zE z7z3CioS1?u#9#71v8&NT`kLqL-D_VN$|euFc@w=lw>Rg%hYudWIL-T4awf;2^(+fj zr0tKup?lKdvb#R!F{{Yyukp8xyjO~&GRu@Xj2wRc&6dwHe}($b$%7b7th-`y=3J~>u^73lK6HrtpsWk|?Y1p+X*6sIXayUoM609R%m$TU8w!C)bhgi$sU9)^KmMxlRzDW?>qJjB#qDEC;mIfpmVF5=9`@QU1s|&__xrA-|~#8^$sHVO-M_u*H+>;KG`lL zeadb5UDn?XwMTM{%4#{Hmdq{0?}m~$a;PDHw_#0wFO=T|uFG$a*00WQjPg6N!bMM; z_9p&2rxE|@XwNlY`~9 zaLR>9>u)=4ZoigwywtU9dFXrKY_HG1!F(&Y2EP-_a((`N@=e-iz1t#w=XAdBk$#_h zez9Eh$BExJ_i%`P0DnCPpl7<14yI$thBcKE|L29h`hcBW>s;ft5g$+xhyfBCZtfe0 zezEn9U6qBs=?h{-JnXljg}dZ`AKdS^He6E9jxo9xnwvUdaQCqHenYUYU!A^y-w$p+ zAR6&})-QH1X`k3WeLwf@ecM<2PxI~p(ifQXeB?a;({Fz!R_0dDef{TY|EdG~c_!e- zA?^i)VgUUCeSr9d2ZtwNO7E7aProV{HzE$r=+EVQ&Aty1OlY5me4A}Tx#-B6{Qh?> z^9}HrCbbdM#4Gcg;PPGY5){cgzX9%2Yv%Ng=s!d+Li4NLv(5eXxcGnhhIH%k9T895 zW9j!}#qWFjeevAiiRV7AiS_jV5(7dxKC;?h^kS@tQYg{B1-Gp2XkN1J71lHK>NJQH{|(rm3ZNP0+oal$%*@ z%53AeorRJpmt=So^kBIMKA<5ckN&FfY|f<)D0U|L(J0Q#9VTH`hBr` ziTk|gXYhA$SNv5UBoC1HLeJRF-19lc*;ipM@hftF@YwdH_+eiPt{<9)TZgA}k8lRQ ztJv^ij@#%iiE-o)y@}dqvwxTQ;pn_QGs*>Che#l6N!4HlVE;lItEK zStI)OhO|i`u}$$ES~q_D17b+>Kwna>+}Gse!|&9<$Gh1=xG;bAFrZ7rv+H29Ex83WGlS5V6z&bB@#G|C0N8_b%)P`iyo|5$M>MGTFqxeR+3g=*>aDh&hqk=yx+2V1$u4e_jGnl zLxLfmzax*`%6*wFLX**VM+%O8`3b)J{(F4OZvqMb^wfVaZ1+60H!N+uUB> z-Ku29@;r}l&K1Ww0^O1RuGmiIrtq#ck z5A%J&-owAwk$L8RP-R^AR~Vz0sJo&IVTmzhEn~=-y^DCZ&U=5Rcec`;wKaB^hFM>2 z!Y{Xf#qB%yLUfauWu4kZTx6U*kELs~;5l9GH_zl5-_G|jbN}X}i{BCRd$>v5Z~jU> zApiRE1@u0#ka2*x%ifniguP4oObudzIHYl-J6 zSx)MpRMM% zgMKl7+F(VzuHC$axnFJx#cI(L#Yk<|>Vlrz61}kcA%49h{mg;$Ut0SY{Jl8v@x||v zbbP*tzl{MV4$vQT=J+{#bN+N|zUPT`xVgj!EZnjNJrD7{3TFK+*WKbTI?#pB+wVI2 zDQ%uHK(M0iAG>f0y-#K%mi|8!r;V?+=k0yptv=jxkrj$%yqWPuE-qZZYJ7mqD>{}z zUnA%I>>i+>1Bh;pKJ+10ZF+wD>fx@%^J;q)bJN+oR+xKg<{1hTe{Iec$Gw&w$Fs2T ztDV@!{A~F*`!VR`;*gEXeLBel3~ojTe7m)HQYJKNZ zbwqhZu772aS;@2VBlj&b-(C|RtUBQ0XK*xnLCid?6-UKX@V7dkx}n_aL@f2d$S@Cx zC8@5MxFNsm`HEggvXHs+)xy3q;P|Y6gX97$xQ{rB`Jg;|sq1iS|Evoxg1tu;e;dyw zrdzW1Us4AIW2*zUUGNvbBJGw;{wQ(B!@oCk{rNlAREm7>Y3=xF<)0O=7cowBAcyxD z#_w6ebJq0Pf{F3_g1cv%;6V%EHB);1_KVry%~9)R@Qrx z8`^cB?+<)E2#de*72-dH?7o66d-L)6{O)|#WA4rsSk3cJ;)5#FwGccNQ{@%?`<_<5 zqVv8ixix%e&d?q6_&n__^Uj4tVjp|dyI0Gy_y(gBv|sBFd|mK;gJN&FT|;mzeTA$Y zV~@;6?>(tlk-N6iVE=n?)3M557FN&ucf=0oZRGcr_D)B~gR_vbeFbSHhVhx|Zt~7m z!QayXn*JpL$;+NX8&Y!zi*A_n;`-rCLtM%Ag6KoW4!)0*IpfUT%Q2la zYd8JHu9cX-eKnRar(3nret$7I&%7-wkjV2u@q4FY7QfZ&_E+@peGzhsmGX-IhT>k@ zxYF7yI{(X%lV>XjZk>ZRd&gif&j740=i8a84`uPv{%*yR%j`e&*>1(o#U)&u+wYb|R_e+t+ULssk>wQ|)*@;9B%TQy!*{GNf1$Ro z|4!or=w}k-S+;HCu_U*0JlmzXE0$W%NSQOT+5$i~9S- z2h7-2C#pzaryaw2au}i;VeY{rxXH_6M)O z)|D$xW&O==pN|RdY#?t=(cG&h(oaMjt`dIIl}eX?|1lk zi;Rv5%2(B&Ki8t&R_n{byZf|V~{(*A>ERWA7V1m(i@SG7I8UdZ(hUfZ%TP+67H z@#S56Up_qk6`iNN->K?RaWrTHsRVHj;oyXX}L6B5t-7){#n}f8oU4AaBb2bu3g*I=CvNg)SbVoT)ysB uU8AaNRHXw|I#8tpRXXsx=)fCQ|EszJRac`, ``, and `` with the values obtained in step 4: + + ``` + curl -X POST -u : -H "Content-Type: application/json" -d '{ "message": "Hello, world!", "phoneNumbers": ["79990001234", "79995556677"] }' http://:8080/message + ``` + +## Cloud server + +If you need to send messages with dynamic or shared device IP, you can use the cloud server. The best part? No registration, email, or phone number is required to start using it. + +1. Start the app on the device. +2. Activate the `Cloud server` switch. +3. Tap the `Offline` button at the bottom of the screen. +4. In the `Cloud server` section, the credentials for basic authentication will be displayed. +5. Make a curl call using a command like the following, replacing `` and `` with the values obtained in step 4: + + ``` + curl -X POST -u : -H "Content-Type: application/json" -d '{ "message": "Hello, world!", "phoneNumbers": ["79990001234", "79995556677"] }' https://sms.capcom.me/api/3rdparty/v1/message + ``` \ No newline at end of file diff --git a/web/mkdocs/docs/index.md b/web/mkdocs/docs/index.md new file mode 100644 index 0000000..62ab97a --- /dev/null +++ b/web/mkdocs/docs/index.md @@ -0,0 +1,43 @@ +# Android SMS Gateway + +![Project logo](logo.png) + +Android SMS Gateway turns your Android smartphone into an SMS gateway. It's a lightweight application allowing you to send SMS messages programmatically via API. This makes it ideal for integrating SMS functionality into your own applications or services. + +## Features + +- **Send SMS programmatically:** Use our API to send messages directly from your own applications or services. +- **Supports Android 5.0 and above:** The application is compatible with Android 5.0 and later versions. +- **Message status tracking:** Monitor the status of your sent messages in real-time. +- **Starts at boot:** The application starts running as soon as your device boots up. +- **Prevents sleep mode:** Your device won't go to sleep while the application is running, ensuring continuous service. + +## Ideal For + +- Notifications +- Alerts +- Two-factor authentication codes + +Android SMS Gateway provides a convenient and reliable solution, whether you need to send notifications, alerts, or two-factor authentication codes. + +## Project Stage + +The project is currently in the MVP stage. We're actively working on adding more features and improving the existing ones. + +## Get Started + +Getting started with Android SMS Gateway is easy and straightforward. No registration, email, or phone number is required to create an account and start using the app. + +Check out our [Getting Started Guide](getting-started.md) to learn how to install and use Android SMS Gateway. + +## Contributing + +Interested in contributing? Read our [Contributing Guide](contributing.md) to find out how you can help. + +## License + +This project is licensed under the [Apache License 2.0](license.md). + +## Contact + +If you have any questions or suggestions, feel free to [create an issue](https://github.com/capcom6/android-sms-gateway/issues/new) or [send us an email](mailto:i@capcom.me). \ No newline at end of file diff --git a/web/mkdocs/docs/installation.md b/web/mkdocs/docs/installation.md new file mode 100644 index 0000000..c97a13e --- /dev/null +++ b/web/mkdocs/docs/installation.md @@ -0,0 +1,18 @@ +# Installation + +You can install app to your device from prebuilt APK or by building from sources. + +## Prerequisites + +You need an Android device with Android 5.0 (Lollipop) or above for using the application. + +## Installation from APK + +1. Navigate to the [Releases](https://github.com/capcom6/android-sms-gateway/releases) page. +2. Download the latest APK file from the list of available releases. +3. Transfer the APK file to your Android device. +4. On your Android device, go to **Settings** > **Security** (or **Privacy** on some devices). +5. Enable the **Unknown sources** option to allow installation of apps from sources other than the Play Store. +6. Use a file manager app to navigate to the location of the downloaded APK file. +7. Tap on the APK file to start the installation process. +8. Follow the on-screen prompts to complete the installation. \ No newline at end of file diff --git a/web/mkdocs/docs/license.md b/web/mkdocs/docs/license.md new file mode 100644 index 0000000..f49a4e1 --- /dev/null +++ b/web/mkdocs/docs/license.md @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/web/static/images/logo.png b/web/mkdocs/docs/logo.png similarity index 100% rename from web/static/images/logo.png rename to web/mkdocs/docs/logo.png diff --git a/web/mkdocs/docs/pricing.md b/web/mkdocs/docs/pricing.md new file mode 100644 index 0000000..bd6c9e7 --- /dev/null +++ b/web/mkdocs/docs/pricing.md @@ -0,0 +1,9 @@ +# Pricing + +Using the Android SMS Gateway comes with different pricing based on the server you choose to use: + +- **Local Server**: Utilizing the local server to send messages is always free, with no restrictions or limits. + +- **Cloud Server**: Using the cloud server to send your messages may be subject to certain limits. If you are planning to send more than 1000 messages per month using the cloud server, we recommend reaching out to us for more information and possible arrangements. + +For further inquiries or clarification, feel free to [contact us](mailto:i@capcom.me). \ No newline at end of file diff --git a/web/mkdocs/mkdocs.yml b/web/mkdocs/mkdocs.yml new file mode 100644 index 0000000..32a82c5 --- /dev/null +++ b/web/mkdocs/mkdocs.yml @@ -0,0 +1,22 @@ +site_name: Android SMS Gateway +site_url: https://sms.capcom.me +theme: + name: material +nav: + - Home: index.md + - Installation: installation.md + - Getting Started: getting-started.md + - API: api.md + - Pricing: pricing.md + - Contributing: contributing.md + - License: license.md +plugins: + - search + - render_swagger + - minify: + minify_html: true + minify_js: true + minify_css: true + htmlmin_opts: + remove_comments: true + cache_safe: true diff --git a/web/static/getting-started.html b/web/static/getting-started.html deleted file mode 100644 index 8ddaea5..0000000 --- a/web/static/getting-started.html +++ /dev/null @@ -1,28 +0,0 @@ - - - - - Getting Started - Android SMS Gateway - - - - -
-
-

Getting Started - Android SMS Gateway

-
-
- -
-

Step 1: Installation

-

Here you provide instructions about how to install your application.

- -

Step 2: Configuration

-

Here you provide instructions about how to configure your application after it has been installed.

- -

Step 3: Usage

-

Here you provide instructions about how to use your application.

-
- - - \ No newline at end of file diff --git a/web/static/index.html b/web/static/index.html deleted file mode 100644 index 842c795..0000000 --- a/web/static/index.html +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Android SMS Gateway - - - - -
-
-

Android SMS Gateway

-
-
- -
- Project logo -

Android SMS Gateway turns your Android smartphone into an SMS gateway. It's a lightweight application - allowing you to send SMS messages programmatically via API. This makes it ideal for integrating SMS - functionality into your own applications or services.

- -

Features

-
    -
  • Send SMS programmatically: Use our API to send messages directly from your own applications or services. -
    • -
  • Supports Android 5.0 and above: The application is compatible with Android 5.0 and later versions.
    • -
  • Message status tracking: Monitor the status of your sent messages in real-time.
    • -
  • Starts at boot: The application starts running as soon as your device boots up.
    • -
  • Prevents sleep mode: Your device won't go to sleep while the application is running, ensuring continuous - service.
    • -
- -

Ideal For

-
    -
  • Notifications
    • -
  • Alerts
    • -
  • Two-factor authentication codes
    • -
- -

Project Stage

-

The project is currently in the MVP stage. We're actively working on adding more features and improving the - existing ones.

- -

Get Started

-

Check out our Getting Started Guide to learn how to install and use - Android SMS Gateway.

- -

Contributing

-

Interested in contributing? Read our Contributing Guide to find out how you - can help.

- -

License

-

This project is licensed under the Apache License 2.0.

- -

Contact

-

If you have any questions or suggestions, feel free to create an issue or send us an email.

-
- - - \ No newline at end of file diff --git a/web/static/styles.css b/web/static/styles.css deleted file mode 100644 index 2a92dcc..0000000 --- a/web/static/styles.css +++ /dev/null @@ -1,40 +0,0 @@ -body { - font-family: Arial, sans-serif; - margin: 0; - padding: 0; - background-color: #f4f4f4; -} - -.container { - width: 80%; - margin: auto; - overflow: hidden; -} - -header { - background: #50a8a8; - color: white; - padding-top: 30px; - min-height: 70px; - border-bottom: #396969 3px solid; -} - -header a { - color: #ffffff; - text-decoration: none; - text-transform: uppercase; - font-size: 16px; -} - -header h1 { - float: left; - margin: 0; -} - -header #underline { - color: #396969; -} - -h2 { - color: #396969; -} \ No newline at end of file