diff --git a/Makefile b/Makefile index ab0c62e..6a0f830 100644 --- a/Makefile +++ b/Makefile @@ -51,7 +51,7 @@ docker-dev: api-docs: swag fmt -g ./cmd/$(project_name)/main.go \ - && swag init -g ./cmd/$(project_name)/main.go -o ./api + && swag init --parseDependency -g ./cmd/$(project_name)/main.go -o ./api view-docs: php -S 127.0.0.1:8080 -t ./api diff --git a/api/swagger.json b/api/swagger.json index 4e3026e..c879f57 100644 --- a/api/swagger.json +++ b/api/swagger.json @@ -4,13 +4,13 @@ ], "swagger": "2.0", "info": { - "description": "End-user authentication key", + "description": "Provides an API for (Android) SMS Gateway", "title": "SMS Gateway - API", "contact": { "name": "Aleksandr Soloshenko", "email": "i@capcom.me" }, - "version": "1.0.0" + "version": "{APP_VERSION}" }, "host": "sms.capcom.me", "basePath": "/api", diff --git a/api/swagger.yaml b/api/swagger.yaml index 071f3bf..42a981e 100644 --- a/api/swagger.yaml +++ b/api/swagger.yaml @@ -273,9 +273,9 @@ info: contact: email: i@capcom.me name: Aleksandr Soloshenko - description: End-user authentication key + description: Provides an API for (Android) SMS Gateway title: SMS Gateway - API - version: 1.0.0 + version: '{APP_VERSION}' paths: /3rdparty/v1/device: get: diff --git a/build/package/Dockerfile b/build/package/Dockerfile index 7fea8e9..eb79180 100644 --- a/build/package/Dockerfile +++ b/build/package/Dockerfile @@ -6,6 +6,9 @@ ARG APP_VERSION=1.0.0 ARG APP_RELEASE_ID=1 WORKDIR /go/src +# Install swag +RUN go install github.com/swaggo/swag/cmd/swag@latest + # Copy go.mod and go.sum COPY go.* ./ @@ -15,23 +18,16 @@ RUN go mod download # Copy all the Code and stuff to compile everything COPY . . +# Replace {APP_VERSION} with the actual version +RUN sed -i "s/{APP_VERSION}/${APP_VERSION}/g" ./cmd/${APP}/main.go + +# Generate swagger docs +RUN swag init --parseDependency -g ./cmd/${APP}/main.go -o ./api + # Builds the application as a staticly linked one, to allow it to run on alpine # RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -installsuffix cgo -o app . RUN CGO_ENABLED=0 go build -a -installsuffix cgo -ldflags="-w -s -X github.com/capcom6/${APP}/internal/version.AppVersion=${APP_VERSION} -X github.com/capcom6/${APP}/internal/version.AppRelease=${APP_RELEASE_ID}" -o app ./cmd/${APP}/main.go -# Build MkDocs -FROM squidfunk/mkdocs-material:9.5.15 AS mkdocs - -WORKDIR /docs - -RUN pip install --no-cache-dir mkdocs-render-swagger-plugin - -COPY web/mkdocs/fonts ./.cache/plugin/social/fonts/Roboto -COPY web/mkdocs . - -RUN mkdocs build - - # Moving the binary to the 'final Image' to make it smaller FROM alpine:3 as prod @@ -41,7 +37,7 @@ RUN apk add --no-cache tzdata COPY scripts/docker-entrypoint.sh /docker-entrypoint.sh -COPY --from=mkdocs /docs/site /app/static +COPY --from=build /go/src/api /app/api COPY --from=build /go/src/app /app # Exposes port 3000 because our program listens on that port diff --git a/cmd/sms-gateway/main.go b/cmd/sms-gateway/main.go index f85c19e..acb5db1 100644 --- a/cmd/sms-gateway/main.go +++ b/cmd/sms-gateway/main.go @@ -4,21 +4,19 @@ import ( smsgateway "github.com/capcom6/sms-gateway/internal/sms-gateway" ) -// @title SMS Gateway - API -// @version 1.0.0 -// @description Provides API for (Android) SMS Gateway - -// @contact.name Aleksandr Soloshenko -// @contact.email i@capcom.me +// @securitydefinitions.basic ApiAuth // @securitydefinitions.apikey MobileToken // @in header // @name Authorization // @description Mobile device token -// @securitydefinitions.basic ApiAuth -// @in header -// @description End-user authentication key +// @title SMS Gateway - API +// @version {APP_VERSION} +// @description Provides an API for (Android) SMS Gateway + +// @contact.name Aleksandr Soloshenko +// @contact.email i@capcom.me // @host localhost:3000 // @host sms.capcom.me diff --git a/internal/sms-gateway/handlers/root.go b/internal/sms-gateway/handlers/root.go index 14dd15f..b224412 100644 --- a/internal/sms-gateway/handlers/root.go +++ b/internal/sms-gateway/handlers/root.go @@ -10,7 +10,7 @@ type rootHandler struct { func (h *rootHandler) Register(app *fiber.App) { h.healthHandler.Register(app) - app.Static("/", "static") + app.Static("/api", "api") } func newRootHandler(healthHandler *healthHandler) *rootHandler { diff --git a/web/mkdocs/.dockerignore b/web/mkdocs/.dockerignore deleted file mode 100644 index 206d46e..0000000 --- a/web/mkdocs/.dockerignore +++ /dev/null @@ -1,3 +0,0 @@ -venv/ -site/ -.cache/ diff --git a/web/mkdocs/.gitignore b/web/mkdocs/.gitignore deleted file mode 100644 index 206d46e..0000000 --- a/web/mkdocs/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -venv/ -site/ -.cache/ diff --git a/web/mkdocs/Pipfile b/web/mkdocs/Pipfile deleted file mode 100644 index 7b21a79..0000000 --- a/web/mkdocs/Pipfile +++ /dev/null @@ -1,17 +0,0 @@ -[[source]] -url = "https://pypi.org/simple" -verify_ssl = true -name = "pypi" - -[packages] - - -[dev-packages] -mkdocs = "~=1.5.3" -mkdocs-material-extensions = "~=1.3" -mkdocs-minify-plugin = "~=0.7.1" -mkdocs-render-swagger-plugin = "~=0.1.1" -mkdocs-material = {extras = ["imaging"], version = "~=9.5.3"} - -[requires] -python_version = "3" diff --git a/web/mkdocs/Pipfile.lock b/web/mkdocs/Pipfile.lock deleted file mode 100644 index c67af08..0000000 --- a/web/mkdocs/Pipfile.lock +++ /dev/null @@ -1,781 +0,0 @@ -{ - "_meta": { - "hash": { - "sha256": "d3e277f5a93081c44ec06d3c32f3995fcc21e737ab3ab5bcb7211b90c3efa532" - }, - "pipfile-spec": 6, - "requires": { - "python_version": "3.11" - }, - "sources": [ - { - "name": "pypi", - "url": "https://pypi.org/simple", - "verify_ssl": true - } - ] - }, - "default": {}, - "develop": { - "babel": { - "hashes": [ - "sha256:6919867db036398ba21eb5c7a0f6b28ab8cbc3ae7a73a44ebe34ae74a4e7d363", - "sha256:efb1a25b7118e67ce3a259bed20545c29cb68be8ad2c784c83689981b7a57287" - ], - "markers": "python_version >= '3.7'", - "version": "==2.14.0" - }, - "cairocffi": { - "hashes": [ - "sha256:78e6bbe47357640c453d0be929fa49cd05cce2e1286f3d2a1ca9cbda7efdb8b7", - "sha256:aa78ee52b9069d7475eeac457389b6275aa92111895d78fbaa2202a52dac112e" - ], - "markers": "python_version >= '3.7'", - "version": "==1.6.1" - }, - "cairosvg": { - "hashes": [ - "sha256:432531d72347291b9a9ebfb6777026b607563fd8719c46ee742db0aef7271ba0", - "sha256:8a5222d4e6c3f86f1f7046b63246877a63b49923a1cd202184c3a634ef546b3b" - ], - "version": "==2.7.1" - }, - "certifi": { - "hashes": [ - "sha256:0569859f95fc761b18b45ef421b1290a0f65f147e92a1e5eb3e635f9a5e4e66f", - "sha256:dc383c07b76109f368f6106eee2b593b04a011ea4d55f652c6ca24a754d1cdd1" - ], - "markers": "python_version >= '3.6'", - "version": "==2024.2.2" - }, - "cffi": { - "hashes": [ - "sha256:0c9ef6ff37e974b73c25eecc13952c55bceed9112be2d9d938ded8e856138bcc", - "sha256:131fd094d1065b19540c3d72594260f118b231090295d8c34e19a7bbcf2e860a", - "sha256:1b8ebc27c014c59692bb2664c7d13ce7a6e9a629be20e54e7271fa696ff2b417", - "sha256:2c56b361916f390cd758a57f2e16233eb4f64bcbeee88a4881ea90fca14dc6ab", - "sha256:2d92b25dbf6cae33f65005baf472d2c245c050b1ce709cc4588cdcdd5495b520", - "sha256:31d13b0f99e0836b7ff893d37af07366ebc90b678b6664c955b54561fc36ef36", - "sha256:32c68ef735dbe5857c810328cb2481e24722a59a2003018885514d4c09af9743", - "sha256:3686dffb02459559c74dd3d81748269ffb0eb027c39a6fc99502de37d501faa8", - "sha256:582215a0e9adbe0e379761260553ba11c58943e4bbe9c36430c4ca6ac74b15ed", - "sha256:5b50bf3f55561dac5438f8e70bfcdfd74543fd60df5fa5f62d94e5867deca684", - "sha256:5bf44d66cdf9e893637896c7faa22298baebcd18d1ddb6d2626a6e39793a1d56", - "sha256:6602bc8dc6f3a9e02b6c22c4fc1e47aa50f8f8e6d3f78a5e16ac33ef5fefa324", - "sha256:673739cb539f8cdaa07d92d02efa93c9ccf87e345b9a0b556e3ecc666718468d", - "sha256:68678abf380b42ce21a5f2abde8efee05c114c2fdb2e9eef2efdb0257fba1235", - "sha256:68e7c44931cc171c54ccb702482e9fc723192e88d25a0e133edd7aff8fcd1f6e", - "sha256:6b3d6606d369fc1da4fd8c357d026317fbb9c9b75d36dc16e90e84c26854b088", - "sha256:748dcd1e3d3d7cd5443ef03ce8685043294ad6bd7c02a38d1bd367cfd968e000", - "sha256:7651c50c8c5ef7bdb41108b7b8c5a83013bfaa8a935590c5d74627c047a583c7", - "sha256:7b78010e7b97fef4bee1e896df8a4bbb6712b7f05b7ef630f9d1da00f6444d2e", - "sha256:7e61e3e4fa664a8588aa25c883eab612a188c725755afff6289454d6362b9673", - "sha256:80876338e19c951fdfed6198e70bc88f1c9758b94578d5a7c4c91a87af3cf31c", - "sha256:8895613bcc094d4a1b2dbe179d88d7fb4a15cee43c052e8885783fac397d91fe", - "sha256:88e2b3c14bdb32e440be531ade29d3c50a1a59cd4e51b1dd8b0865c54ea5d2e2", - "sha256:8f8e709127c6c77446a8c0a8c8bf3c8ee706a06cd44b1e827c3e6a2ee6b8c098", - "sha256:9cb4a35b3642fc5c005a6755a5d17c6c8b6bcb6981baf81cea8bfbc8903e8ba8", - "sha256:9f90389693731ff1f659e55c7d1640e2ec43ff725cc61b04b2f9c6d8d017df6a", - "sha256:a09582f178759ee8128d9270cd1344154fd473bb77d94ce0aeb2a93ebf0feaf0", - "sha256:a6a14b17d7e17fa0d207ac08642c8820f84f25ce17a442fd15e27ea18d67c59b", - "sha256:a72e8961a86d19bdb45851d8f1f08b041ea37d2bd8d4fd19903bc3083d80c896", - "sha256:abd808f9c129ba2beda4cfc53bde801e5bcf9d6e0f22f095e45327c038bfe68e", - "sha256:ac0f5edd2360eea2f1daa9e26a41db02dd4b0451b48f7c318e217ee092a213e9", - "sha256:b29ebffcf550f9da55bec9e02ad430c992a87e5f512cd63388abb76f1036d8d2", - "sha256:b2ca4e77f9f47c55c194982e10f058db063937845bb2b7a86c84a6cfe0aefa8b", - "sha256:b7be2d771cdba2942e13215c4e340bfd76398e9227ad10402a8767ab1865d2e6", - "sha256:b84834d0cf97e7d27dd5b7f3aca7b6e9263c56308ab9dc8aae9784abb774d404", - "sha256:b86851a328eedc692acf81fb05444bdf1891747c25af7529e39ddafaf68a4f3f", - "sha256:bcb3ef43e58665bbda2fb198698fcae6776483e0c4a631aa5647806c25e02cc0", - "sha256:c0f31130ebc2d37cdd8e44605fb5fa7ad59049298b3f745c74fa74c62fbfcfc4", - "sha256:c6a164aa47843fb1b01e941d385aab7215563bb8816d80ff3a363a9f8448a8dc", - "sha256:d8a9d3ebe49f084ad71f9269834ceccbf398253c9fac910c4fd7053ff1386936", - "sha256:db8e577c19c0fda0beb7e0d4e09e0ba74b1e4c092e0e40bfa12fe05b6f6d75ba", - "sha256:dc9b18bf40cc75f66f40a7379f6a9513244fe33c0e8aa72e2d56b0196a7ef872", - "sha256:e09f3ff613345df5e8c3667da1d918f9149bd623cd9070c983c013792a9a62eb", - "sha256:e4108df7fe9b707191e55f33efbcb2d81928e10cea45527879a4749cbe472614", - "sha256:e6024675e67af929088fda399b2094574609396b1decb609c55fa58b028a32a1", - "sha256:e70f54f1796669ef691ca07d046cd81a29cb4deb1e5f942003f401c0c4a2695d", - "sha256:e715596e683d2ce000574bae5d07bd522c781a822866c20495e52520564f0969", - "sha256:e760191dd42581e023a68b758769e2da259b5d52e3103c6060ddc02c9edb8d7b", - "sha256:ed86a35631f7bfbb28e108dd96773b9d5a6ce4811cf6ea468bb6a359b256b1e4", - "sha256:ee07e47c12890ef248766a6e55bd38ebfb2bb8edd4142d56db91b21ea68b7627", - "sha256:fa3a0128b152627161ce47201262d3140edb5a5c3da88d73a1b790a959126956", - "sha256:fcc8eb6d5902bb1cf6dc4f187ee3ea80a1eba0a89aba40a5cb20a5087d961357" - ], - "markers": "python_version >= '3.8'", - "version": "==1.16.0" - }, - "charset-normalizer": { - "hashes": [ - "sha256:06435b539f889b1f6f4ac1758871aae42dc3a8c0e24ac9e60c2384973ad73027", - "sha256:06a81e93cd441c56a9b65d8e1d043daeb97a3d0856d177d5c90ba85acb3db087", - "sha256:0a55554a2fa0d408816b3b5cedf0045f4b8e1a6065aec45849de2d6f3f8e9786", - "sha256:0b2b64d2bb6d3fb9112bafa732def486049e63de9618b5843bcdd081d8144cd8", - "sha256:10955842570876604d404661fbccbc9c7e684caf432c09c715ec38fbae45ae09", - "sha256:122c7fa62b130ed55f8f285bfd56d5f4b4a5b503609d181f9ad85e55c89f4185", - "sha256:1ceae2f17a9c33cb48e3263960dc5fc8005351ee19db217e9b1bb15d28c02574", - "sha256:1d3193f4a680c64b4b6a9115943538edb896edc190f0b222e73761716519268e", - "sha256:1f79682fbe303db92bc2b1136016a38a42e835d932bab5b3b1bfcfbf0640e519", - "sha256:2127566c664442652f024c837091890cb1942c30937add288223dc895793f898", - "sha256:22afcb9f253dac0696b5a4be4a1c0f8762f8239e21b99680099abd9b2b1b2269", - "sha256:25baf083bf6f6b341f4121c2f3c548875ee6f5339300e08be3f2b2ba1721cdd3", - "sha256:2e81c7b9c8979ce92ed306c249d46894776a909505d8f5a4ba55b14206e3222f", - "sha256:3287761bc4ee9e33561a7e058c72ac0938c4f57fe49a09eae428fd88aafe7bb6", - "sha256:34d1c8da1e78d2e001f363791c98a272bb734000fcef47a491c1e3b0505657a8", - "sha256:37e55c8e51c236f95b033f6fb391d7d7970ba5fe7ff453dad675e88cf303377a", - "sha256:3d47fa203a7bd9c5b6cee4736ee84ca03b8ef23193c0d1ca99b5089f72645c73", - "sha256:3e4d1f6587322d2788836a99c69062fbb091331ec940e02d12d179c1d53e25fc", - "sha256:42cb296636fcc8b0644486d15c12376cb9fa75443e00fb25de0b8602e64c1714", - "sha256:45485e01ff4d3630ec0d9617310448a8702f70e9c01906b0d0118bdf9d124cf2", - "sha256:4a78b2b446bd7c934f5dcedc588903fb2f5eec172f3d29e52a9096a43722adfc", - "sha256:4ab2fe47fae9e0f9dee8c04187ce5d09f48eabe611be8259444906793ab7cbce", - "sha256:4d0d1650369165a14e14e1e47b372cfcb31d6ab44e6e33cb2d4e57265290044d", - "sha256:549a3a73da901d5bc3ce8d24e0600d1fa85524c10287f6004fbab87672bf3e1e", - "sha256:55086ee1064215781fff39a1af09518bc9255b50d6333f2e4c74ca09fac6a8f6", - "sha256:572c3763a264ba47b3cf708a44ce965d98555f618ca42c926a9c1616d8f34269", - "sha256:573f6eac48f4769d667c4442081b1794f52919e7edada77495aaed9236d13a96", - "sha256:5b4c145409bef602a690e7cfad0a15a55c13320ff7a3ad7ca59c13bb8ba4d45d", - "sha256:6463effa3186ea09411d50efc7d85360b38d5f09b870c48e4600f63af490e56a", - "sha256:65f6f63034100ead094b8744b3b97965785388f308a64cf8d7c34f2f2e5be0c4", - "sha256:663946639d296df6a2bb2aa51b60a2454ca1cb29835324c640dafb5ff2131a77", - "sha256:6897af51655e3691ff853668779c7bad41579facacf5fd7253b0133308cf000d", - "sha256:68d1f8a9e9e37c1223b656399be5d6b448dea850bed7d0f87a8311f1ff3dabb0", - "sha256:6ac7ffc7ad6d040517be39eb591cac5ff87416c2537df6ba3cba3bae290c0fed", - "sha256:6b3251890fff30ee142c44144871185dbe13b11bab478a88887a639655be1068", - "sha256:6c4caeef8fa63d06bd437cd4bdcf3ffefe6738fb1b25951440d80dc7df8c03ac", - "sha256:6ef1d82a3af9d3eecdba2321dc1b3c238245d890843e040e41e470ffa64c3e25", - "sha256:753f10e867343b4511128c6ed8c82f7bec3bd026875576dfd88483c5c73b2fd8", - "sha256:7cd13a2e3ddeed6913a65e66e94b51d80a041145a026c27e6bb76c31a853c6ab", - "sha256:7ed9e526742851e8d5cc9e6cf41427dfc6068d4f5a3bb03659444b4cabf6bc26", - "sha256:7f04c839ed0b6b98b1a7501a002144b76c18fb1c1850c8b98d458ac269e26ed2", - "sha256:802fe99cca7457642125a8a88a084cef28ff0cf9407060f7b93dca5aa25480db", - "sha256:80402cd6ee291dcb72644d6eac93785fe2c8b9cb30893c1af5b8fdd753b9d40f", - "sha256:8465322196c8b4d7ab6d1e049e4c5cb460d0394da4a27d23cc242fbf0034b6b5", - "sha256:86216b5cee4b06df986d214f664305142d9c76df9b6512be2738aa72a2048f99", - "sha256:87d1351268731db79e0f8e745d92493ee2841c974128ef629dc518b937d9194c", - "sha256:8bdb58ff7ba23002a4c5808d608e4e6c687175724f54a5dade5fa8c67b604e4d", - "sha256:8c622a5fe39a48f78944a87d4fb8a53ee07344641b0562c540d840748571b811", - "sha256:8d756e44e94489e49571086ef83b2bb8ce311e730092d2c34ca8f7d925cb20aa", - "sha256:8f4a014bc36d3c57402e2977dada34f9c12300af536839dc38c0beab8878f38a", - "sha256:9063e24fdb1e498ab71cb7419e24622516c4a04476b17a2dab57e8baa30d6e03", - "sha256:90d558489962fd4918143277a773316e56c72da56ec7aa3dc3dbbe20fdfed15b", - "sha256:923c0c831b7cfcb071580d3f46c4baf50f174be571576556269530f4bbd79d04", - "sha256:95f2a5796329323b8f0512e09dbb7a1860c46a39da62ecb2324f116fa8fdc85c", - "sha256:96b02a3dc4381e5494fad39be677abcb5e6634bf7b4fa83a6dd3112607547001", - "sha256:9f96df6923e21816da7e0ad3fd47dd8f94b2a5ce594e00677c0013018b813458", - "sha256:a10af20b82360ab00827f916a6058451b723b4e65030c5a18577c8b2de5b3389", - "sha256:a50aebfa173e157099939b17f18600f72f84eed3049e743b68ad15bd69b6bf99", - "sha256:a981a536974bbc7a512cf44ed14938cf01030a99e9b3a06dd59578882f06f985", - "sha256:a9a8e9031d613fd2009c182b69c7b2c1ef8239a0efb1df3f7c8da66d5dd3d537", - "sha256:ae5f4161f18c61806f411a13b0310bea87f987c7d2ecdbdaad0e94eb2e404238", - "sha256:aed38f6e4fb3f5d6bf81bfa990a07806be9d83cf7bacef998ab1a9bd660a581f", - "sha256:b01b88d45a6fcb69667cd6d2f7a9aeb4bf53760d7fc536bf679ec94fe9f3ff3d", - "sha256:b261ccdec7821281dade748d088bb6e9b69e6d15b30652b74cbbac25e280b796", - "sha256:b2b0a0c0517616b6869869f8c581d4eb2dd83a4d79e0ebcb7d373ef9956aeb0a", - "sha256:b4a23f61ce87adf89be746c8a8974fe1c823c891d8f86eb218bb957c924bb143", - "sha256:bd8f7df7d12c2db9fab40bdd87a7c09b1530128315d047a086fa3ae3435cb3a8", - "sha256:beb58fe5cdb101e3a055192ac291b7a21e3b7ef4f67fa1d74e331a7f2124341c", - "sha256:c002b4ffc0be611f0d9da932eb0f704fe2602a9a949d1f738e4c34c75b0863d5", - "sha256:c083af607d2515612056a31f0a8d9e0fcb5876b7bfc0abad3ecd275bc4ebc2d5", - "sha256:c180f51afb394e165eafe4ac2936a14bee3eb10debc9d9e4db8958fe36afe711", - "sha256:c235ebd9baae02f1b77bcea61bce332cb4331dc3617d254df3323aa01ab47bd4", - "sha256:cd70574b12bb8a4d2aaa0094515df2463cb429d8536cfb6c7ce983246983e5a6", - "sha256:d0eccceffcb53201b5bfebb52600a5fb483a20b61da9dbc885f8b103cbe7598c", - "sha256:d965bba47ddeec8cd560687584e88cf699fd28f192ceb452d1d7ee807c5597b7", - "sha256:db364eca23f876da6f9e16c9da0df51aa4f104a972735574842618b8c6d999d4", - "sha256:ddbb2551d7e0102e7252db79ba445cdab71b26640817ab1e3e3648dad515003b", - "sha256:deb6be0ac38ece9ba87dea880e438f25ca3eddfac8b002a2ec3d9183a454e8ae", - "sha256:e06ed3eb3218bc64786f7db41917d4e686cc4856944f53d5bdf83a6884432e12", - "sha256:e27ad930a842b4c5eb8ac0016b0a54f5aebbe679340c26101df33424142c143c", - "sha256:e537484df0d8f426ce2afb2d0f8e1c3d0b114b83f8850e5f2fbea0e797bd82ae", - "sha256:eb00ed941194665c332bf8e078baf037d6c35d7c4f3102ea2d4f16ca94a26dc8", - "sha256:eb6904c354526e758fda7167b33005998fb68c46fbc10e013ca97f21ca5c8887", - "sha256:eb8821e09e916165e160797a6c17edda0679379a4be5c716c260e836e122f54b", - "sha256:efcb3f6676480691518c177e3b465bcddf57cea040302f9f4e6e191af91174d4", - "sha256:f27273b60488abe721a075bcca6d7f3964f9f6f067c8c4c605743023d7d3944f", - "sha256:f30c3cb33b24454a82faecaf01b19c18562b1e89558fb6c56de4d9118a032fd5", - "sha256:fb69256e180cb6c8a894fee62b3afebae785babc1ee98b81cdf68bbca1987f33", - "sha256:fd1abc0d89e30cc4e02e4064dc67fcc51bd941eb395c502aac3ec19fab46b519", - "sha256:ff8fa367d09b717b2a17a052544193ad76cd49979c805768879cb63d9ca50561" - ], - "markers": "python_full_version >= '3.7.0'", - "version": "==3.3.2" - }, - "click": { - "hashes": [ - "sha256:ae74fb96c20a0277a1d615f1e4d73c8414f5a98db8b799a7931d1582f3390c28", - "sha256:ca9853ad459e787e2192211578cc907e7594e294c7ccc834310722b41b9ca6de" - ], - "markers": "python_version >= '3.7'", - "version": "==8.1.7" - }, - "colorama": { - "hashes": [ - "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44", - "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6" - ], - "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6'", - "version": "==0.4.6" - }, - "csscompressor": { - "hashes": [ - "sha256:afa22badbcf3120a4f392e4d22f9fff485c044a1feda4a950ecc5eba9dd31a05" - ], - "version": "==0.9.5" - }, - "cssselect2": { - "hashes": [ - "sha256:1ccd984dab89fc68955043aca4e1b03e0cf29cad9880f6e28e3ba7a74b14aa5a", - "sha256:fd23a65bfd444595913f02fc71f6b286c29261e354c41d722ca7a261a49b5969" - ], - "markers": "python_version >= '3.7'", - "version": "==0.7.0" - }, - "defusedxml": { - "hashes": [ - "sha256:1bb3032db185915b62d7c6209c5a8792be6a32ab2fedacc84e01b52c51aa3e69", - "sha256:a352e7e428770286cc899e2542b6cdaedb2b4953ff269a210103ec58f6198a61" - ], - "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'", - "version": "==0.7.1" - }, - "ghp-import": { - "hashes": [ - "sha256:8337dd7b50877f163d4c0289bc1f1c7f127550241988d568c1db512c4324a619", - "sha256:9c535c4c61193c2df8871222567d7fd7e5014d835f97dc7b7439069e2413d343" - ], - "version": "==2.1.0" - }, - "htmlmin2": { - "hashes": [ - "sha256:75609f2a42e64f7ce57dbff28a39890363bde9e7e5885db633317efbdf8c79a2" - ], - "version": "==0.1.13" - }, - "idna": { - "hashes": [ - "sha256:028ff3aadf0609c1fd278d8ea3089299412a7a8b9bd005dd08b9f8285bcb5cfc", - "sha256:82fee1fc78add43492d3a1898bfa6d8a904cc97d8427f683ed8e798d07761aa0" - ], - "markers": "python_version >= '3.5'", - "version": "==3.7" - }, - "jinja2": { - "hashes": [ - "sha256:4a3aee7acbbe7303aede8e9648d13b8bf88a429282aa6122a993f0ac800cb369", - "sha256:bc5dd2abb727a5319567b7a813e6a2e7318c39f4f487cfe6c89c6f9c7d25197d" - ], - "index": "pypi", - "markers": "python_version >= '3.7'", - "version": "==3.1.4" - }, - "jsmin": { - "hashes": [ - "sha256:c0959a121ef94542e807a674142606f7e90214a2b3d1eb17300244bbb5cc2bfc" - ], - "version": "==3.0.1" - }, - "markdown": { - "hashes": [ - "sha256:5874b47d4ee3f0b14d764324d2c94c03ea66bee56f2d929da9f2508d65e722dc", - "sha256:b65d7beb248dc22f2e8a31fb706d93798093c308dc1aba295aedeb9d41a813bd" - ], - "markers": "python_version >= '3.8'", - "version": "==3.5.1" - }, - "markupsafe": { - "hashes": [ - "sha256:00e046b6dd71aa03a41079792f8473dc494d564611a8f89bbbd7cb93295ebdcf", - "sha256:075202fa5b72c86ad32dc7d0b56024ebdbcf2048c0ba09f1cde31bfdd57bcfff", - "sha256:0e397ac966fdf721b2c528cf028494e86172b4feba51d65f81ffd65c63798f3f", - "sha256:17b950fccb810b3293638215058e432159d2b71005c74371d784862b7e4683f3", - "sha256:1f3fbcb7ef1f16e48246f704ab79d79da8a46891e2da03f8783a5b6fa41a9532", - "sha256:2174c595a0d73a3080ca3257b40096db99799265e1c27cc5a610743acd86d62f", - "sha256:2b7c57a4dfc4f16f7142221afe5ba4e093e09e728ca65c51f5620c9aaeb9a617", - "sha256:2d2d793e36e230fd32babe143b04cec8a8b3eb8a3122d2aceb4a371e6b09b8df", - "sha256:30b600cf0a7ac9234b2638fbc0fb6158ba5bdcdf46aeb631ead21248b9affbc4", - "sha256:397081c1a0bfb5124355710fe79478cdbeb39626492b15d399526ae53422b906", - "sha256:3a57fdd7ce31c7ff06cdfbf31dafa96cc533c21e443d57f5b1ecc6cdc668ec7f", - "sha256:3c6b973f22eb18a789b1460b4b91bf04ae3f0c4234a0a6aa6b0a92f6f7b951d4", - "sha256:3e53af139f8579a6d5f7b76549125f0d94d7e630761a2111bc431fd820e163b8", - "sha256:4096e9de5c6fdf43fb4f04c26fb114f61ef0bf2e5604b6ee3019d51b69e8c371", - "sha256:4275d846e41ecefa46e2015117a9f491e57a71ddd59bbead77e904dc02b1bed2", - "sha256:4c31f53cdae6ecfa91a77820e8b151dba54ab528ba65dfd235c80b086d68a465", - "sha256:4f11aa001c540f62c6166c7726f71f7573b52c68c31f014c25cc7901deea0b52", - "sha256:5049256f536511ee3f7e1b3f87d1d1209d327e818e6ae1365e8653d7e3abb6a6", - "sha256:58c98fee265677f63a4385256a6d7683ab1832f3ddd1e66fe948d5880c21a169", - "sha256:598e3276b64aff0e7b3451b72e94fa3c238d452e7ddcd893c3ab324717456bad", - "sha256:5b7b716f97b52c5a14bffdf688f971b2d5ef4029127f1ad7a513973cfd818df2", - "sha256:5dedb4db619ba5a2787a94d877bc8ffc0566f92a01c0ef214865e54ecc9ee5e0", - "sha256:619bc166c4f2de5caa5a633b8b7326fbe98e0ccbfacabd87268a2b15ff73a029", - "sha256:629ddd2ca402ae6dbedfceeba9c46d5f7b2a61d9749597d4307f943ef198fc1f", - "sha256:656f7526c69fac7f600bd1f400991cc282b417d17539a1b228617081106feb4a", - "sha256:6ec585f69cec0aa07d945b20805be741395e28ac1627333b1c5b0105962ffced", - "sha256:72b6be590cc35924b02c78ef34b467da4ba07e4e0f0454a2c5907f473fc50ce5", - "sha256:7502934a33b54030eaf1194c21c692a534196063db72176b0c4028e140f8f32c", - "sha256:7a68b554d356a91cce1236aa7682dc01df0edba8d043fd1ce607c49dd3c1edcf", - "sha256:7b2e5a267c855eea6b4283940daa6e88a285f5f2a67f2220203786dfa59b37e9", - "sha256:823b65d8706e32ad2df51ed89496147a42a2a6e01c13cfb6ffb8b1e92bc910bb", - "sha256:8590b4ae07a35970728874632fed7bd57b26b0102df2d2b233b6d9d82f6c62ad", - "sha256:8dd717634f5a044f860435c1d8c16a270ddf0ef8588d4887037c5028b859b0c3", - "sha256:8dec4936e9c3100156f8a2dc89c4b88d5c435175ff03413b443469c7c8c5f4d1", - "sha256:97cafb1f3cbcd3fd2b6fbfb99ae11cdb14deea0736fc2b0952ee177f2b813a46", - "sha256:a17a92de5231666cfbe003f0e4b9b3a7ae3afb1ec2845aadc2bacc93ff85febc", - "sha256:a549b9c31bec33820e885335b451286e2969a2d9e24879f83fe904a5ce59d70a", - "sha256:ac07bad82163452a6884fe8fa0963fb98c2346ba78d779ec06bd7a6262132aee", - "sha256:ae2ad8ae6ebee9d2d94b17fb62763125f3f374c25618198f40cbb8b525411900", - "sha256:b91c037585eba9095565a3556f611e3cbfaa42ca1e865f7b8015fe5c7336d5a5", - "sha256:bc1667f8b83f48511b94671e0e441401371dfd0f0a795c7daa4a3cd1dde55bea", - "sha256:bec0a414d016ac1a18862a519e54b2fd0fc8bbfd6890376898a6c0891dd82e9f", - "sha256:bf50cd79a75d181c9181df03572cdce0fbb75cc353bc350712073108cba98de5", - "sha256:bff1b4290a66b490a2f4719358c0cdcd9bafb6b8f061e45c7a2460866bf50c2e", - "sha256:c061bb86a71b42465156a3ee7bd58c8c2ceacdbeb95d05a99893e08b8467359a", - "sha256:c8b29db45f8fe46ad280a7294f5c3ec36dbac9491f2d1c17345be8e69cc5928f", - "sha256:ce409136744f6521e39fd8e2a24c53fa18ad67aa5bc7c2cf83645cce5b5c4e50", - "sha256:d050b3361367a06d752db6ead6e7edeb0009be66bc3bae0ee9d97fb326badc2a", - "sha256:d283d37a890ba4c1ae73ffadf8046435c76e7bc2247bbb63c00bd1a709c6544b", - "sha256:d9fad5155d72433c921b782e58892377c44bd6252b5af2f67f16b194987338a4", - "sha256:daa4ee5a243f0f20d528d939d06670a298dd39b1ad5f8a72a4275124a7819eff", - "sha256:db0b55e0f3cc0be60c1f19efdde9a637c32740486004f20d1cff53c3c0ece4d2", - "sha256:e61659ba32cf2cf1481e575d0462554625196a1f2fc06a1c777d3f48e8865d46", - "sha256:ea3d8a3d18833cf4304cd2fc9cbb1efe188ca9b5efef2bdac7adc20594a0e46b", - "sha256:ec6a563cff360b50eed26f13adc43e61bc0c04d94b8be985e6fb24b81f6dcfdf", - "sha256:f5dfb42c4604dddc8e4305050aa6deb084540643ed5804d7455b5df8fe16f5e5", - "sha256:fa173ec60341d6bb97a89f5ea19c85c5643c1e7dedebc22f5181eb73573142c5", - "sha256:fa9db3f79de01457b03d4f01b34cf91bc0048eb2c3846ff26f66687c2f6d16ab", - "sha256:fce659a462a1be54d2ffcacea5e3ba2d74daa74f30f5f143fe0c58636e355fdd", - "sha256:ffee1f21e5ef0d712f9033568f8344d5da8cc2869dbd08d87c84656e6a2d2f68" - ], - "markers": "python_version >= '3.7'", - "version": "==2.1.5" - }, - "mergedeep": { - "hashes": [ - "sha256:0096d52e9dad9939c3d975a774666af186eda617e6ca84df4c94dec30004f2a8", - "sha256:70775750742b25c0d8f36c55aed03d24c3384d17c951b3175d898bd778ef0307" - ], - "markers": "python_version >= '3.6'", - "version": "==1.3.4" - }, - "mkdocs": { - "hashes": [ - "sha256:3b3a78e736b31158d64dbb2f8ba29bd46a379d0c6e324c2246c3bc3d2189cfc1", - "sha256:eb7c99214dcb945313ba30426c2451b735992c73c2e10838f76d09e39ff4d0e2" - ], - "index": "pypi", - "markers": "python_version >= '3.7'", - "version": "==1.5.3" - }, - "mkdocs-material": { - "extras": [ - "imaging" - ], - "hashes": [ - "sha256:5899219f422f0a6de784232d9d40374416302ffae3c160cacc72969fcc1ee372", - "sha256:76c93a8525cceb0b395b9cedab3428bf518cf6439adef2b940f1c1574b775d89" - ], - "markers": "python_version >= '3.8'", - "version": "==9.5.3" - }, - "mkdocs-material-extensions": { - "hashes": [ - "sha256:10c9511cea88f568257f960358a467d12b970e1f7b2c0e5fb2bb48cab1928443", - "sha256:adff8b62700b25cb77b53358dad940f3ef973dd6db797907c49e3c2ef3ab4e31" - ], - "index": "pypi", - "markers": "python_version >= '3.8'", - "version": "==1.3.1" - }, - "mkdocs-minify-plugin": { - "hashes": [ - "sha256:6a551e22d6517eaef9e1890afd60021dc1dcd1255de02d266f588d1ace040713", - "sha256:ae8bfc4a68806883e990ea025938b3f989da7b9fa08ea8390dba47adf25e0c5b" - ], - "index": "pypi", - "markers": "python_version >= '3.8'", - "version": "==0.7.2" - }, - "mkdocs-render-swagger-plugin": { - "hashes": [ - "sha256:1b0f4f92bf69d7e0d56b13f520fdad072ddd1f4ccf031f11706d45d831d4df7b" - ], - "index": "pypi", - "markers": "python_version >= '3.8'", - "version": "==0.1.1" - }, - "packaging": { - "hashes": [ - "sha256:048fb0e9405036518eaaf48a55953c750c11e1a1b68e0dd1a9d62ed0c092cfc5", - "sha256:8c491190033a9af7e1d931d0b5dacc2ef47509b34dd0de67ed209b5203fc88c7" - ], - "markers": "python_version >= '3.7'", - "version": "==23.2" - }, - "paginate": { - "hashes": [ - "sha256:5e6007b6a9398177a7e1648d04fdd9f8c9766a1a945bceac82f1929e8c78af2d" - ], - "version": "==0.5.6" - }, - "pathspec": { - "hashes": [ - "sha256:a0d503e138a4c123b27490a4f7beda6a01c6f288df0e4a8b79c7eb0dc7b4cc08", - "sha256:a482d51503a1ab33b1c67a6c3813a26953dbdc71c31dacaef9a838c4e29f5712" - ], - "markers": "python_version >= '3.8'", - "version": "==0.12.1" - }, - "pillow": { - "hashes": [ - "sha256:048ad577748b9fa4a99a0548c64f2cb8d672d5bf2e643a739ac8faff1164238c", - "sha256:048eeade4c33fdf7e08da40ef402e748df113fd0b4584e32c4af74fe78baaeb2", - "sha256:0ba26351b137ca4e0db0342d5d00d2e355eb29372c05afd544ebf47c0956ffeb", - "sha256:0ea2a783a2bdf2a561808fe4a7a12e9aa3799b701ba305de596bc48b8bdfce9d", - "sha256:1530e8f3a4b965eb6a7785cf17a426c779333eb62c9a7d1bbcf3ffd5bf77a4aa", - "sha256:16563993329b79513f59142a6b02055e10514c1a8e86dca8b48a893e33cf91e3", - "sha256:19aeb96d43902f0a783946a0a87dbdad5c84c936025b8419da0a0cd7724356b1", - "sha256:1a1d1915db1a4fdb2754b9de292642a39a7fb28f1736699527bb649484fb966a", - "sha256:1b87bd9d81d179bd8ab871603bd80d8645729939f90b71e62914e816a76fc6bd", - "sha256:1dfc94946bc60ea375cc39cff0b8da6c7e5f8fcdc1d946beb8da5c216156ddd8", - "sha256:2034f6759a722da3a3dbd91a81148cf884e91d1b747992ca288ab88c1de15999", - "sha256:261ddb7ca91fcf71757979534fb4c128448b5b4c55cb6152d280312062f69599", - "sha256:2ed854e716a89b1afcedea551cd85f2eb2a807613752ab997b9974aaa0d56936", - "sha256:3102045a10945173d38336f6e71a8dc71bcaeed55c3123ad4af82c52807b9375", - "sha256:339894035d0ede518b16073bdc2feef4c991ee991a29774b33e515f1d308e08d", - "sha256:412444afb8c4c7a6cc11a47dade32982439925537e483be7c0ae0cf96c4f6a0b", - "sha256:4203efca580f0dd6f882ca211f923168548f7ba334c189e9eab1178ab840bf60", - "sha256:45ebc7b45406febf07fef35d856f0293a92e7417ae7933207e90bf9090b70572", - "sha256:4b5ec25d8b17217d635f8935dbc1b9aa5907962fae29dff220f2659487891cd3", - "sha256:4c8e73e99da7db1b4cad7f8d682cf6abad7844da39834c288fbfa394a47bbced", - "sha256:4e6f7d1c414191c1199f8996d3f2282b9ebea0945693fb67392c75a3a320941f", - "sha256:4eaa22f0d22b1a7e93ff0a596d57fdede2e550aecffb5a1ef1106aaece48e96b", - "sha256:50b8eae8f7334ec826d6eeffaeeb00e36b5e24aa0b9df322c247539714c6df19", - "sha256:50fd3f6b26e3441ae07b7c979309638b72abc1a25da31a81a7fbd9495713ef4f", - "sha256:51243f1ed5161b9945011a7360e997729776f6e5d7005ba0c6879267d4c5139d", - "sha256:5d512aafa1d32efa014fa041d38868fda85028e3f930a96f85d49c7d8ddc0383", - "sha256:5f77cf66e96ae734717d341c145c5949c63180842a545c47a0ce7ae52ca83795", - "sha256:6b02471b72526ab8a18c39cb7967b72d194ec53c1fd0a70b050565a0f366d355", - "sha256:6fb1b30043271ec92dc65f6d9f0b7a830c210b8a96423074b15c7bc999975f57", - "sha256:7161ec49ef0800947dc5570f86568a7bb36fa97dd09e9827dc02b718c5643f09", - "sha256:72d622d262e463dfb7595202d229f5f3ab4b852289a1cd09650362db23b9eb0b", - "sha256:74d28c17412d9caa1066f7a31df8403ec23d5268ba46cd0ad2c50fb82ae40462", - "sha256:78618cdbccaa74d3f88d0ad6cb8ac3007f1a6fa5c6f19af64b55ca170bfa1edf", - "sha256:793b4e24db2e8742ca6423d3fde8396db336698c55cd34b660663ee9e45ed37f", - "sha256:798232c92e7665fe82ac085f9d8e8ca98826f8e27859d9a96b41d519ecd2e49a", - "sha256:81d09caa7b27ef4e61cb7d8fbf1714f5aec1c6b6c5270ee53504981e6e9121ad", - "sha256:8ab74c06ffdab957d7670c2a5a6e1a70181cd10b727cd788c4dd9005b6a8acd9", - "sha256:8eb0908e954d093b02a543dc963984d6e99ad2b5e36503d8a0aaf040505f747d", - "sha256:90b9e29824800e90c84e4022dd5cc16eb2d9605ee13f05d47641eb183cd73d45", - "sha256:9797a6c8fe16f25749b371c02e2ade0efb51155e767a971c61734b1bf6293994", - "sha256:9d2455fbf44c914840c793e89aa82d0e1763a14253a000743719ae5946814b2d", - "sha256:9d3bea1c75f8c53ee4d505c3e67d8c158ad4df0d83170605b50b64025917f338", - "sha256:9e2ec1e921fd07c7cda7962bad283acc2f2a9ccc1b971ee4b216b75fad6f0463", - "sha256:9e91179a242bbc99be65e139e30690e081fe6cb91a8e77faf4c409653de39451", - "sha256:a0eaa93d054751ee9964afa21c06247779b90440ca41d184aeb5d410f20ff591", - "sha256:a2c405445c79c3f5a124573a051062300936b0281fee57637e706453e452746c", - "sha256:aa7e402ce11f0885305bfb6afb3434b3cd8f53b563ac065452d9d5654c7b86fd", - "sha256:aff76a55a8aa8364d25400a210a65ff59d0168e0b4285ba6bf2bd83cf675ba32", - "sha256:b09b86b27a064c9624d0a6c54da01c1beaf5b6cadfa609cf63789b1d08a797b9", - "sha256:b14f16f94cbc61215115b9b1236f9c18403c15dd3c52cf629072afa9d54c1cbf", - "sha256:b50811d664d392f02f7761621303eba9d1b056fb1868c8cdf4231279645c25f5", - "sha256:b7bc2176354defba3edc2b9a777744462da2f8e921fbaf61e52acb95bafa9828", - "sha256:c78e1b00a87ce43bb37642c0812315b411e856a905d58d597750eb79802aaaa3", - "sha256:c83341b89884e2b2e55886e8fbbf37c3fa5efd6c8907124aeb72f285ae5696e5", - "sha256:ca2870d5d10d8726a27396d3ca4cf7976cec0f3cb706debe88e3a5bd4610f7d2", - "sha256:ccce24b7ad89adb5a1e34a6ba96ac2530046763912806ad4c247356a8f33a67b", - "sha256:cd5e14fbf22a87321b24c88669aad3a51ec052eb145315b3da3b7e3cc105b9a2", - "sha256:ce49c67f4ea0609933d01c0731b34b8695a7a748d6c8d186f95e7d085d2fe475", - "sha256:d33891be6df59d93df4d846640f0e46f1a807339f09e79a8040bc887bdcd7ed3", - "sha256:d3b2348a78bc939b4fed6552abfd2e7988e0f81443ef3911a4b8498ca084f6eb", - "sha256:d886f5d353333b4771d21267c7ecc75b710f1a73d72d03ca06df49b09015a9ef", - "sha256:d93480005693d247f8346bc8ee28c72a2191bdf1f6b5db469c096c0c867ac015", - "sha256:dc1a390a82755a8c26c9964d457d4c9cbec5405896cba94cf51f36ea0d855002", - "sha256:dd78700f5788ae180b5ee8902c6aea5a5726bac7c364b202b4b3e3ba2d293170", - "sha256:e46f38133e5a060d46bd630faa4d9fa0202377495df1f068a8299fd78c84de84", - "sha256:e4b878386c4bf293578b48fc570b84ecfe477d3b77ba39a6e87150af77f40c57", - "sha256:f0d0591a0aeaefdaf9a5e545e7485f89910c977087e7de2b6c388aec32011e9f", - "sha256:fdcbb4068117dfd9ce0138d068ac512843c52295ed996ae6dd1faf537b6dbc27", - "sha256:ff61bfd9253c3915e6d41c651d5f962da23eda633cf02262990094a18a55371a" - ], - "index": "pypi", - "markers": "python_version >= '3.8'", - "version": "==10.3.0" - }, - "platformdirs": { - "hashes": [ - "sha256:11c8f37bcca40db96d8144522d925583bdb7a31f7b0e37e3ed4318400a8e2380", - "sha256:906d548203468492d432bcb294d4bc2fff751bf84971fbb2c10918cc206ee420" - ], - "markers": "python_version >= '3.8'", - "version": "==4.1.0" - }, - "pycparser": { - "hashes": [ - "sha256:8ee45429555515e1f6b185e78100aea234072576aa43ab53aefcae078162fca9", - "sha256:e644fdec12f7872f86c58ff790da456218b10f863970249516d60a5eaca77206" - ], - "version": "==2.21" - }, - "pygments": { - "hashes": [ - "sha256:b27c2826c47d0f3219f29554824c30c5e8945175d888647acd804ddd04af846c", - "sha256:da46cec9fd2de5be3a8a784f434e4c4ab670b4ff54d605c4c2717e9d49c4c367" - ], - "markers": "python_version >= '3.7'", - "version": "==2.17.2" - }, - "pymdown-extensions": { - "hashes": [ - "sha256:561eb3a5f3c3c2512952a4d6f5b311aa124b7147bd54a3ea0f36ce030c7e3dd9", - "sha256:e4531379e0d74b329ff264217ef5b8b1a37bed3afe36f98001b74ecff52215c0" - ], - "markers": "python_version >= '3.8'", - "version": "==10.6" - }, - "python-dateutil": { - "hashes": [ - "sha256:0123cacc1627ae19ddf3c27a5de5bd67ee4586fbdd6440d9748f8abb483d3e86", - "sha256:961d03dc3453ebbc59dbdea9e4e11c5651520a876d0f4db161e8674aae935da9" - ], - "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", - "version": "==2.8.2" - }, - "pyyaml": { - "hashes": [ - "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5", - "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc", - "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df", - "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741", - "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206", - "sha256:18aeb1bf9a78867dc38b259769503436b7c72f7a1f1f4c93ff9a17de54319b27", - "sha256:1d4c7e777c441b20e32f52bd377e0c409713e8bb1386e1099c2415f26e479595", - "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62", - "sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98", - "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696", - "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290", - "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9", - "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d", - "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6", - "sha256:4fb147e7a67ef577a588a0e2c17b6db51dda102c71de36f8549b6816a96e1867", - "sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47", - "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486", - "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6", - "sha256:596106435fa6ad000c2991a98fa58eeb8656ef2325d7e158344fb33864ed87e3", - "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007", - "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938", - "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0", - "sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c", - "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735", - "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d", - "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28", - "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4", - "sha256:9046c58c4395dff28dd494285c82ba00b546adfc7ef001486fbf0324bc174fba", - "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8", - "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5", - "sha256:afd7e57eddb1a54f0f1a974bc4391af8bcce0b444685d936840f125cf046d5bd", - "sha256:b1275ad35a5d18c62a7220633c913e1b42d44b46ee12554e5fd39c70a243d6a3", - "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0", - "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515", - "sha256:baa90d3f661d43131ca170712d903e6295d1f7a0f595074f151c0aed377c9b9c", - "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c", - "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924", - "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34", - "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43", - "sha256:c8098ddcc2a85b61647b2590f825f3db38891662cfc2fc776415143f599bb859", - "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673", - "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54", - "sha256:d858aa552c999bc8a8d57426ed01e40bef403cd8ccdd0fc5f6f04a00414cac2a", - "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b", - "sha256:f003ed9ad21d6a4713f0a9b5a7a0a79e08dd0f221aff4525a2be4c346ee60aab", - "sha256:f22ac1c3cac4dbc50079e965eba2c1058622631e526bd9afd45fedd49ba781fa", - "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c", - "sha256:fca0e3a251908a499833aa292323f32437106001d436eca0e6e7833256674585", - "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d", - "sha256:fd66fc5d0da6d9815ba2cebeb4205f95818ff4b79c3ebe268e75d961704af52f" - ], - "markers": "python_version >= '3.6'", - "version": "==6.0.1" - }, - "pyyaml-env-tag": { - "hashes": [ - "sha256:70092675bda14fdec33b31ba77e7543de9ddc88f2e5b99160396572d11525bdb", - "sha256:af31106dec8a4d68c60207c1886031cbf839b68aa7abccdb19868200532c2069" - ], - "markers": "python_version >= '3.6'", - "version": "==0.1" - }, - "regex": { - "hashes": [ - "sha256:0694219a1d54336fd0445ea382d49d36882415c0134ee1e8332afd1529f0baa5", - "sha256:086dd15e9435b393ae06f96ab69ab2d333f5d65cbe65ca5a3ef0ec9564dfe770", - "sha256:094ba386bb5c01e54e14434d4caabf6583334090865b23ef58e0424a6286d3dc", - "sha256:09da66917262d9481c719599116c7dc0c321ffcec4b1f510c4f8a066f8768105", - "sha256:0ecf44ddf9171cd7566ef1768047f6e66975788258b1c6c6ca78098b95cf9a3d", - "sha256:0fda75704357805eb953a3ee15a2b240694a9a514548cd49b3c5124b4e2ad01b", - "sha256:11a963f8e25ab5c61348d090bf1b07f1953929c13bd2309a0662e9ff680763c9", - "sha256:150c39f5b964e4d7dba46a7962a088fbc91f06e606f023ce57bb347a3b2d4630", - "sha256:1b9d811f72210fa9306aeb88385b8f8bcef0dfbf3873410413c00aa94c56c2b6", - "sha256:1e0eabac536b4cc7f57a5f3d095bfa557860ab912f25965e08fe1545e2ed8b4c", - "sha256:22a86d9fff2009302c440b9d799ef2fe322416d2d58fc124b926aa89365ec482", - "sha256:22f3470f7524b6da61e2020672df2f3063676aff444db1daa283c2ea4ed259d6", - "sha256:263ef5cc10979837f243950637fffb06e8daed7f1ac1e39d5910fd29929e489a", - "sha256:283fc8eed679758de38fe493b7d7d84a198b558942b03f017b1f94dda8efae80", - "sha256:29171aa128da69afdf4bde412d5bedc335f2ca8fcfe4489038577d05f16181e5", - "sha256:298dc6354d414bc921581be85695d18912bea163a8b23cac9a2562bbcd5088b1", - "sha256:2aae8101919e8aa05ecfe6322b278f41ce2994c4a430303c4cd163fef746e04f", - "sha256:2f4e475a80ecbd15896a976aa0b386c5525d0ed34d5c600b6d3ebac0a67c7ddf", - "sha256:34e4af5b27232f68042aa40a91c3b9bb4da0eeb31b7632e0091afc4310afe6cb", - "sha256:37f8e93a81fc5e5bd8db7e10e62dc64261bcd88f8d7e6640aaebe9bc180d9ce2", - "sha256:3a17d3ede18f9cedcbe23d2daa8a2cd6f59fe2bf082c567e43083bba3fb00347", - "sha256:3b1de218d5375cd6ac4b5493e0b9f3df2be331e86520f23382f216c137913d20", - "sha256:43f7cd5754d02a56ae4ebb91b33461dc67be8e3e0153f593c509e21d219c5060", - "sha256:4558410b7a5607a645e9804a3e9dd509af12fb72b9825b13791a37cd417d73a5", - "sha256:4719bb05094d7d8563a450cf8738d2e1061420f79cfcc1fa7f0a44744c4d8f73", - "sha256:4bfc2b16e3ba8850e0e262467275dd4d62f0d045e0e9eda2bc65078c0110a11f", - "sha256:518440c991f514331f4850a63560321f833979d145d7d81186dbe2f19e27ae3d", - "sha256:51f4b32f793812714fd5307222a7f77e739b9bc566dc94a18126aba3b92b98a3", - "sha256:531ac6cf22b53e0696f8e1d56ce2396311254eb806111ddd3922c9d937151dae", - "sha256:5cd05d0f57846d8ba4b71d9c00f6f37d6b97d5e5ef8b3c3840426a475c8f70f4", - "sha256:5dd58946bce44b53b06d94aa95560d0b243eb2fe64227cba50017a8d8b3cd3e2", - "sha256:60080bb3d8617d96f0fb7e19796384cc2467447ef1c491694850ebd3670bc457", - "sha256:636ba0a77de609d6510235b7f0e77ec494d2657108f777e8765efc060094c98c", - "sha256:67d3ccfc590e5e7197750fcb3a2915b416a53e2de847a728cfa60141054123d4", - "sha256:68191f80a9bad283432385961d9efe09d783bcd36ed35a60fb1ff3f1ec2efe87", - "sha256:7502534e55c7c36c0978c91ba6f61703faf7ce733715ca48f499d3dbbd7657e0", - "sha256:7aa47c2e9ea33a4a2a05f40fcd3ea36d73853a2aae7b4feab6fc85f8bf2c9704", - "sha256:7d2af3f6b8419661a0c421584cfe8aaec1c0e435ce7e47ee2a97e344b98f794f", - "sha256:7e316026cc1095f2a3e8cc012822c99f413b702eaa2ca5408a513609488cb62f", - "sha256:88ad44e220e22b63b0f8f81f007e8abbb92874d8ced66f32571ef8beb0643b2b", - "sha256:88d1f7bef20c721359d8675f7d9f8e414ec5003d8f642fdfd8087777ff7f94b5", - "sha256:89723d2112697feaa320c9d351e5f5e7b841e83f8b143dba8e2d2b5f04e10923", - "sha256:8a0ccf52bb37d1a700375a6b395bff5dd15c50acb745f7db30415bae3c2b0715", - "sha256:8c2c19dae8a3eb0ea45a8448356ed561be843b13cbc34b840922ddf565498c1c", - "sha256:905466ad1702ed4acfd67a902af50b8db1feeb9781436372261808df7a2a7bca", - "sha256:9852b76ab558e45b20bf1893b59af64a28bd3820b0c2efc80e0a70a4a3ea51c1", - "sha256:98a2636994f943b871786c9e82bfe7883ecdaba2ef5df54e1450fa9869d1f756", - "sha256:9aa1a67bbf0f957bbe096375887b2505f5d8ae16bf04488e8b0f334c36e31360", - "sha256:9eda5f7a50141291beda3edd00abc2d4a5b16c29c92daf8d5bd76934150f3edc", - "sha256:a6d1047952c0b8104a1d371f88f4ab62e6275567d4458c1e26e9627ad489b445", - "sha256:a9b6d73353f777630626f403b0652055ebfe8ff142a44ec2cf18ae470395766e", - "sha256:a9cc99d6946d750eb75827cb53c4371b8b0fe89c733a94b1573c9dd16ea6c9e4", - "sha256:ad83e7545b4ab69216cef4cc47e344d19622e28aabec61574b20257c65466d6a", - "sha256:b014333bd0217ad3d54c143de9d4b9a3ca1c5a29a6d0d554952ea071cff0f1f8", - "sha256:b43523d7bc2abd757119dbfb38af91b5735eea45537ec6ec3a5ec3f9562a1c53", - "sha256:b521dcecebc5b978b447f0f69b5b7f3840eac454862270406a39837ffae4e697", - "sha256:b77e27b79448e34c2c51c09836033056a0547aa360c45eeeb67803da7b0eedaf", - "sha256:b7a635871143661feccce3979e1727c4e094f2bdfd3ec4b90dfd4f16f571a87a", - "sha256:b7fca9205b59c1a3d5031f7e64ed627a1074730a51c2a80e97653e3e9fa0d415", - "sha256:ba1b30765a55acf15dce3f364e4928b80858fa8f979ad41f862358939bdd1f2f", - "sha256:ba99d8077424501b9616b43a2d208095746fb1284fc5ba490139651f971d39d9", - "sha256:c25a8ad70e716f96e13a637802813f65d8a6760ef48672aa3502f4c24ea8b400", - "sha256:c3c4a78615b7762740531c27cf46e2f388d8d727d0c0c739e72048beb26c8a9d", - "sha256:c40281f7d70baf6e0db0c2f7472b31609f5bc2748fe7275ea65a0b4601d9b392", - "sha256:c7ad32824b7f02bb3c9f80306d405a1d9b7bb89362d68b3c5a9be53836caebdb", - "sha256:cb3fe77aec8f1995611f966d0c656fdce398317f850d0e6e7aebdfe61f40e1cd", - "sha256:cc038b2d8b1470364b1888a98fd22d616fba2b6309c5b5f181ad4483e0017861", - "sha256:cc37b9aeebab425f11f27e5e9e6cf580be7206c6582a64467a14dda211abc232", - "sha256:cc6bb9aa69aacf0f6032c307da718f61a40cf970849e471254e0e91c56ffca95", - "sha256:d126361607b33c4eb7b36debc173bf25d7805847346dd4d99b5499e1fef52bc7", - "sha256:d15b274f9e15b1a0b7a45d2ac86d1f634d983ca40d6b886721626c47a400bf39", - "sha256:d166eafc19f4718df38887b2bbe1467a4f74a9830e8605089ea7a30dd4da8887", - "sha256:d498eea3f581fbe1b34b59c697512a8baef88212f92e4c7830fcc1499f5b45a5", - "sha256:d6f7e255e5fa94642a0724e35406e6cb7001c09d476ab5fce002f652b36d0c39", - "sha256:d78bd484930c1da2b9679290a41cdb25cc127d783768a0369d6b449e72f88beb", - "sha256:d865984b3f71f6d0af64d0d88f5733521698f6c16f445bb09ce746c92c97c586", - "sha256:d902a43085a308cef32c0d3aea962524b725403fd9373dea18110904003bac97", - "sha256:d94a1db462d5690ebf6ae86d11c5e420042b9898af5dcf278bd97d6bda065423", - "sha256:da695d75ac97cb1cd725adac136d25ca687da4536154cdc2815f576e4da11c69", - "sha256:db2a0b1857f18b11e3b0e54ddfefc96af46b0896fb678c85f63fb8c37518b3e7", - "sha256:df26481f0c7a3f8739fecb3e81bc9da3fcfae34d6c094563b9d4670b047312e1", - "sha256:e14b73607d6231f3cc4622809c196b540a6a44e903bcfad940779c80dffa7be7", - "sha256:e2610e9406d3b0073636a3a2e80db05a02f0c3169b5632022b4e81c0364bcda5", - "sha256:e692296c4cc2873967771345a876bcfc1c547e8dd695c6b89342488b0ea55cd8", - "sha256:e693e233ac92ba83a87024e1d32b5f9ab15ca55ddd916d878146f4e3406b5c91", - "sha256:e81469f7d01efed9b53740aedd26085f20d49da65f9c1f41e822a33992cb1590", - "sha256:e8c7e08bb566de4faaf11984af13f6bcf6a08f327b13631d41d62592681d24fe", - "sha256:ed19b3a05ae0c97dd8f75a5d8f21f7723a8c33bbc555da6bbe1f96c470139d3c", - "sha256:efb2d82f33b2212898f1659fb1c2e9ac30493ac41e4d53123da374c3b5541e64", - "sha256:f44dd4d68697559d007462b0a3a1d9acd61d97072b71f6d1968daef26bc744bd", - "sha256:f72cbae7f6b01591f90814250e636065850c5926751af02bb48da94dfced7baa", - "sha256:f7bc09bc9c29ebead055bcba136a67378f03d66bf359e87d0f7c759d6d4ffa31", - "sha256:ff100b203092af77d1a5a7abe085b3506b7eaaf9abf65b73b7d6905b6cb76988" - ], - "markers": "python_version >= '3.7'", - "version": "==2023.12.25" - }, - "requests": { - "hashes": [ - "sha256:dd951ff5ecf3e3b3aa26b40703ba77495dab41da839ae72ef3c8e5d8e2433289", - "sha256:fc06670dd0ed212426dfeb94fc1b983d917c4f9847c863f313c9dfaaffb7c23c" - ], - "index": "pypi", - "markers": "python_version >= '3.8'", - "version": "==2.32.2" - }, - "six": { - "hashes": [ - "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926", - "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254" - ], - "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", - "version": "==1.16.0" - }, - "tinycss2": { - "hashes": [ - "sha256:2b80a96d41e7c3914b8cda8bc7f705a4d9c49275616e886103dd839dfc847847", - "sha256:8cff3a8f066c2ec677c06dbc7b45619804a6938478d9d73c284b29d14ecb0627" - ], - "markers": "python_version >= '3.7'", - "version": "==1.2.1" - }, - "urllib3": { - "hashes": [ - "sha256:450b20ec296a467077128bff42b73080516e71b56ff59a60a02bef2232c4fa9d", - "sha256:d0570876c61ab9e520d776c38acbbb5b05a776d3f9ff98a5c8fd5162a444cf19" - ], - "markers": "python_version >= '3.8'", - "version": "==2.2.1" - }, - "watchdog": { - "hashes": [ - "sha256:0e06ab8858a76e1219e68c7573dfeba9dd1c0219476c5a44d5333b01d7e1743a", - "sha256:13bbbb462ee42ec3c5723e1205be8ced776f05b100e4737518c67c8325cf6100", - "sha256:233b5817932685d39a7896b1090353fc8efc1ef99c9c054e46c8002561252fb8", - "sha256:25f70b4aa53bd743729c7475d7ec41093a580528b100e9a8c5b5efe8899592fc", - "sha256:2b57a1e730af3156d13b7fdddfc23dea6487fceca29fc75c5a868beed29177ae", - "sha256:336adfc6f5cc4e037d52db31194f7581ff744b67382eb6021c868322e32eef41", - "sha256:3aa7f6a12e831ddfe78cdd4f8996af9cf334fd6346531b16cec61c3b3c0d8da0", - "sha256:3ed7c71a9dccfe838c2f0b6314ed0d9b22e77d268c67e015450a29036a81f60f", - "sha256:4c9956d27be0bb08fc5f30d9d0179a855436e655f046d288e2bcc11adfae893c", - "sha256:4d98a320595da7a7c5a18fc48cb633c2e73cda78f93cac2ef42d42bf609a33f9", - "sha256:4f94069eb16657d2c6faada4624c39464f65c05606af50bb7902e036e3219be3", - "sha256:5113334cf8cf0ac8cd45e1f8309a603291b614191c9add34d33075727a967709", - "sha256:51f90f73b4697bac9c9a78394c3acbbd331ccd3655c11be1a15ae6fe289a8c83", - "sha256:5d9f3a10e02d7371cd929b5d8f11e87d4bad890212ed3901f9b4d68767bee759", - "sha256:7ade88d0d778b1b222adebcc0927428f883db07017618a5e684fd03b83342bd9", - "sha256:7c5f84b5194c24dd573fa6472685b2a27cc5a17fe5f7b6fd40345378ca6812e3", - "sha256:7e447d172af52ad204d19982739aa2346245cc5ba6f579d16dac4bfec226d2e7", - "sha256:8ae9cda41fa114e28faf86cb137d751a17ffd0316d1c34ccf2235e8a84365c7f", - "sha256:8f3ceecd20d71067c7fd4c9e832d4e22584318983cabc013dbf3f70ea95de346", - "sha256:9fac43a7466eb73e64a9940ac9ed6369baa39b3bf221ae23493a9ec4d0022674", - "sha256:a70a8dcde91be523c35b2bf96196edc5730edb347e374c7de7cd20c43ed95397", - "sha256:adfdeab2da79ea2f76f87eb42a3ab1966a5313e5a69a0213a3cc06ef692b0e96", - "sha256:ba07e92756c97e3aca0912b5cbc4e5ad802f4557212788e72a72a47ff376950d", - "sha256:c07253088265c363d1ddf4b3cdb808d59a0468ecd017770ed716991620b8f77a", - "sha256:c9d8c8ec7efb887333cf71e328e39cffbf771d8f8f95d308ea4125bf5f90ba64", - "sha256:d00e6be486affb5781468457b21a6cbe848c33ef43f9ea4a73b4882e5f188a44", - "sha256:d429c2430c93b7903914e4db9a966c7f2b068dd2ebdd2fa9b9ce094c7d459f33" - ], - "markers": "python_version >= '3.7'", - "version": "==3.0.0" - }, - "webencodings": { - "hashes": [ - "sha256:a0af1213f3c2226497a97e2b3aa01a7e4bee4f403f95be16fc9acd2947514a78", - "sha256:b36a1c245f2d304965eb4e0a82848379241dc04b865afcc4aab16748587e1923" - ], - "version": "==0.5.1" - } - } -} diff --git a/web/mkdocs/docs/api.md b/web/mkdocs/docs/api.md deleted file mode 100644 index b2d0a79..0000000 --- a/web/mkdocs/docs/api.md +++ /dev/null @@ -1,13 +0,0 @@ -# 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. - -## Clients - -We offer client libraries in various programming languages to assist with integration: - -- **[JavaScript / TypeScript](https://github.com/capcom6/android-sms-gateway-ts)**: install the package via npm: `npm install android-sms-gateway` or bun: `bun add android-sms-gateway`; -- **[PHP](https://github.com/capcom6/android-sms-gateway-php)**: install the package via composer: `composer require capcom6/android-sms-gateway`; -- **[Python](https://github.com/capcom6/android-sms-gateway-py)**: install the package via pip: `pip install android-sms-gateway`. diff --git a/web/mkdocs/docs/assets/cloud-server-arch.png b/web/mkdocs/docs/assets/cloud-server-arch.png deleted file mode 100644 index d9c68c4..0000000 Binary files a/web/mkdocs/docs/assets/cloud-server-arch.png and /dev/null differ diff --git a/web/mkdocs/docs/assets/cloud-server.png b/web/mkdocs/docs/assets/cloud-server.png deleted file mode 100644 index 473b08d..0000000 Binary files a/web/mkdocs/docs/assets/cloud-server.png and /dev/null differ diff --git a/web/mkdocs/docs/assets/local-server-arch.png b/web/mkdocs/docs/assets/local-server-arch.png deleted file mode 100644 index 8a4ba6f..0000000 Binary files a/web/mkdocs/docs/assets/local-server-arch.png and /dev/null differ diff --git a/web/mkdocs/docs/assets/local-server.png b/web/mkdocs/docs/assets/local-server.png deleted file mode 100644 index 43e393d..0000000 Binary files a/web/mkdocs/docs/assets/local-server.png and /dev/null differ diff --git a/web/mkdocs/docs/assets/logo.png b/web/mkdocs/docs/assets/logo.png deleted file mode 100644 index 1e573ee..0000000 Binary files a/web/mkdocs/docs/assets/logo.png and /dev/null differ diff --git a/web/mkdocs/docs/assets/private-server-arch.png b/web/mkdocs/docs/assets/private-server-arch.png deleted file mode 100644 index 649a4aa..0000000 Binary files a/web/mkdocs/docs/assets/private-server-arch.png and /dev/null differ diff --git a/web/mkdocs/docs/assets/private-server.png b/web/mkdocs/docs/assets/private-server.png deleted file mode 100644 index cb36f5f..0000000 Binary files a/web/mkdocs/docs/assets/private-server.png and /dev/null differ diff --git a/web/mkdocs/docs/assets/screenshot.png b/web/mkdocs/docs/assets/screenshot.png deleted file mode 100644 index 1617a19..0000000 Binary files a/web/mkdocs/docs/assets/screenshot.png and /dev/null differ diff --git a/web/mkdocs/docs/contributing.md b/web/mkdocs/docs/contributing.md deleted file mode 100644 index bf269e7..0000000 --- a/web/mkdocs/docs/contributing.md +++ /dev/null @@ -1,12 +0,0 @@ -## 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/faq/errors.md b/web/mkdocs/docs/faq/errors.md deleted file mode 100644 index a7436ed..0000000 --- a/web/mkdocs/docs/faq/errors.md +++ /dev/null @@ -1,11 +0,0 @@ -# FAQ - Errors - -## `RESULT_ERROR_LIMIT_EXCEEDED` Error - -The `RESULT_ERROR_LIMIT_EXCEEDED` error occurs when you have reached the sending limit imposed by your mobile carrier or the Android operating system. This safeguard helps prevent spamming and typically triggers if you attempt to send an excessive number of messages in a short span of time. To prevent this, consider spacing out your message sending or contact your carrier to inquire about their message sending limits. For more information, see [How can I avoid mobile operator restrictions?](./general.md#how-can-i-avoid-mobile-operator-restrictions). - -## `RESULT_RIL_MODEM_ERR` Error - -The `RESULT_RIL_MODEM_ERR` error usually indicates a problem with the device's modem or the communication between the application and the modem. This error can stem from a variety of causes, such as issues with the SIM card, network connectivity problems, or firmware-related errors. - -To troubleshoot this error, first try sending a message using the device's default messaging app and check the signal strength. Also, ensure that the SIM card is not blocked by your carrier. diff --git a/web/mkdocs/docs/faq/general.md b/web/mkdocs/docs/faq/general.md deleted file mode 100644 index 1ee86c8..0000000 --- a/web/mkdocs/docs/faq/general.md +++ /dev/null @@ -1,67 +0,0 @@ -# FAQ - -## How can I send an SMS using the second SIM card? - -To send an SMS using a non-default SIM card, you can specify the SIM card slot number in the `simNumber` field of request. For instance, the following request will send an SMS using the second SIM card: - -```sh -curl -X POST \ - -u : \ - -H 'content-type: application/json' \ - https://sms.capcom.me/api/3rdparty/v1/message \ - -d '{ - "message": "Hello from SIM2", - "phoneNumbers": ["79990001234"], - "simNumber": 2 - }' -``` - -## Does the app require power saving mode to be turned off to function without interruptions? - -### Local Mode -- **Power saving settings:** No changes needed. The app uses a foreground service with a wake lock to operate, which allows it to run without power saving mode. -- **Battery impact:** Using wake lock may lead to quicker battery drain. - -### Cloud Mode -- **Power saving settings:** No changes needed. The app uses Firebase Cloud Messaging (FCM) for push notifications, which works without disabling power saving mode. -- **Potential delays:** High message rates could lead to occasional delays when the device is in power-saving modes because of limits on high-priority FCM notifications. - -### Recommendations -- **Testing:** It's advisable to test the app with and without power saving mode activated to see how it performs on your specific device and Android version. -- **Device manufacturers:** Behavior might vary by device manufacturer. -- **Local + Cloud:** For better responsiveness, consider running a local server alongside the cloud server connection. - -See also issue [#17](https://github.com/capcom6/android-sms-gateway/issues/17). - -## How do I enable or disable delivery reports for messages? - -As of version [1.3.0](https://github.com/capcom6/android-sms-gateway/releases/tag/v1.3.0), you have the option to enable or disable delivery reports for each message. By default, the delivery report feature is turned on. If you prefer not to receive delivery reports, you can disable them by setting the `withDeliveryReport` field to `false` in the JSON body of your message request. Here is an example of how to send a message without requesting a delivery report: - -```json -{ - "message": "Your message text here", - "phoneNumbers": ["79990001234", "79995556677"], - "withDeliveryReport": false -} -``` - -## Can I use long or non-standard phone numbers? - -Yes, starting from [1.6.1](https://github.com/capcom6/android-sms-gateway/releases/tag/v1.6.1) of the app, our system allows the use of long or non-standard phone numbers, which may be common with M2M (machine-to-machine) SIM cards or other special cases. To bypass the standard phone number validation, simply add the query parameter `skipPhoneValidation=true` to your API request. Please note that with validation disabled, you are responsible for ensuring the correctness of the phone numbers. They should still follow the E.164 format, beginning with a '+' and containing only digits. - -## How can I avoid mobile operator restrictions? - -The application provides two features to help you avoid mobile operator restrictions: - -### Random delay between messages - -You can introduce a random delay between messages by specifying a maximum delay time. The application will then randomly select a delay within this range for each message sent. This helps to reduce the likelihood of messages being flagged as spam by simulating a more human-like sending pattern. This option is available in the "Messages" section of the device's settings and is named "Delay between messages". - -### Limiting the number of messages sent per period - -The app offers a feature to restrict the number of messages sent within a specified period—be it a minute, hour, or day. You can find this option under the "Limits" section in the device settings. When the limit is reached, the app will pause sending messages until the limit period resets. It's important to note that this feature should not be used for time-sensitive messages, such as sending authorization codes, where delays could cause issues. - -## How to hide messages on device? - -It's not possible to completely hide messages on the device without major changes in the app due to Android's limitations. Messages sent will appear in the default messaging app. The best way to keep messages private is to restrict physical access to the phone. - diff --git a/web/mkdocs/docs/favicon.ico b/web/mkdocs/docs/favicon.ico deleted file mode 100644 index 6450680..0000000 Binary files a/web/mkdocs/docs/favicon.ico and /dev/null differ diff --git a/web/mkdocs/docs/getting-started/index.md b/web/mkdocs/docs/getting-started/index.md deleted file mode 100644 index 79203a7..0000000 --- a/web/mkdocs/docs/getting-started/index.md +++ /dev/null @@ -1,11 +0,0 @@ -# Getting Started - -The Android SMS Gateway can operate in three distinct modes, all using the same API: - -1. [**Local Server**](./local-server.md): Operate entirely within your local network by running the server directly on your Android device. This is perfect for a quick setup and use where Internet access isn't necessary. For remote access, you may need to adjust your network settings and consider additional security measures. -2. [**Public Cloud Server**](./public-cloud-server.md): Connect easily via the Internet using our public server at `sms.capcom.me`. Messages are routed through this server to your devices, which simplifies the setup without the need for network adjustments. This is suitable for non-sensitive data only — for more secure communication, please check out the [end-to-end encryption section](../privacy/encryption.md). -3. [**Private Server**](./private-server.md): Deploy your own server instance and connect your Android devices to ensure maximum privacy. We won't have access to your message content, making this the preferred option for sensitive communication. However, it requires setting up and maintaining your own infrastructure, which includes a database and server application. - -For any of these modes, you'll first need to install the Android SMS Gateway app on your device as described in the [Installation](../installation.md) section. - -For more information on how to use the API, please refer to the [API](../api.md) section. diff --git a/web/mkdocs/docs/getting-started/local-server.md b/web/mkdocs/docs/getting-started/local-server.md deleted file mode 100644 index 7393af5..0000000 --- a/web/mkdocs/docs/getting-started/local-server.md +++ /dev/null @@ -1,22 +0,0 @@ -# Getting Started - -## Local Server - -
- Architecture of the Local Server mode -
- -This mode is ideal for sending messages from a local network. - -1. Launch the app on your device. -2. Toggle the `Local Server` switch to the "on" position. -3. Tap the `Offline` button located at the bottom of the screen to activate the server. -4. The `Local Server` section will display your device's local and public IP addresses, as well as the credentials for basic authentication. Please note that the public IP address is only accessible if you have a public (also known as "white") IP and your firewall is configured appropriately. -
- Example settings for Local Server mode -
-5. To send a message from within the local network, execute a `curl` command like the following. Be sure to replace ``, ``, and `` with the actual values provided in the previous step: - - ```sh - curl -X POST -u : -H "Content-Type: application/json" -d '{ "message": "Hello, world!", "phoneNumbers": ["79990001234", "79995556677"] }' http://:8080/message - ``` diff --git a/web/mkdocs/docs/getting-started/private-server.md b/web/mkdocs/docs/getting-started/private-server.md deleted file mode 100644 index df80a88..0000000 --- a/web/mkdocs/docs/getting-started/private-server.md +++ /dev/null @@ -1,49 +0,0 @@ -# Getting Started - -## Private Server - -
- Architecture of the Private Server mode -
- -To enhance privacy, you can host a private server within your own infrastructure, ensuring that all messages remain solely on devices you control. The only required external network connection is for sending push notifications via the public server at `sms.capcom.me`. This setup eliminates the need to configure Firebase Cloud Messaging (FCM) or rebuild the Android app, but it does demand some technical know-how. - -### Prerequisites - -- A MySQL or MariaDB database server with an empty database, and a user granted full access to that database. -- A Virtual Private Server (VPS) running Linux with Docker installed. -- A reverse proxy with a valid SSL certificate and HTTPS enabled. - -### Run the Server - -1. Create a `config.yml` file based on the template provided in [config.example.yml](https://github.com/capcom6/sms-gateway/blob/master/configs/config.example.yml). Pay special attention to the `database`, `http`, and `gateway` sections. Environment variables can be used to override values in the config file. - - Set `gateway.mode` to `private`. - - Define `gateway.private_token` as the access token for device registration in private mode. Ensure this token matches the one on the devices set to private mode. -2. Start the server in Docker with the following command: - ```sh - docker run -p 3000:3000 -v $(pwd)/config.yml:/app/config.yml capcom6/sms-gateway:latest - ``` -3. Configure your reverse proxy, enable SSL, and modify your firewall settings to permit Internet access to the server. - -Refer to the server's [README.md](https://github.com/capcom6/sms-gateway/blob/master/README.md) for more information. - -See also: - -- [Installation Example with Ubuntu, Docker, and Nginx Proxy Manager](https://github.com/capcom6/android-sms-gateway/discussions/50) -- [Docker Compose Quickstart for Single File Deployment](https://github.com/capcom6/sms-gateway/tree/master/deployments/docker-compose-proxy) - -### Configure the Android App - -
- Example settings for Private Server mode -
- -*Note*: Changing the server will invalidate current credentials, and the device will be re-registered with new ones. - -1. Navigate to the Settings tab. -2. In the Cloud Server section, enter the API URL and Private token, ensuring they match those in the server configuration. Note that you should include the full URL with the path, such as `https://private.example.com/api/mobile/v1`. -3. Switch to the Home tab. -4. Activate the Cloud server option. -5. Apply the new configuration by stopping and starting the app using the button at the bottom of the screen. - -If everything is configured correctly, the new credentials for the private server will be displayed in the Cloud Server section on the Home tab. diff --git a/web/mkdocs/docs/getting-started/public-cloud-server.md b/web/mkdocs/docs/getting-started/public-cloud-server.md deleted file mode 100644 index 4a3a36f..0000000 --- a/web/mkdocs/docs/getting-started/public-cloud-server.md +++ /dev/null @@ -1,22 +0,0 @@ -# Getting Started - -## Cloud Server - -
- Architecture of the Cloud Server mode -
- -Use the cloud server mode when dealing with dynamic or shared device IP addresses. The best part? No registration, email, or phone number is required to start using it. - -1. Launch the app on your device. -2. Toggle the `Cloud Server` switch to the "on" position. -3. Tap the `Online` button located at the bottom of the screen to connect to the cloud server. -4. In the `Cloud Server` section, the credentials for basic authentication will be displayed. -
- Example settings for Cloud Server mode -
-5. To send a message via the cloud server, perform a `curl` request with a command similar to the following, substituting `` and `` with the actual values obtained in step 4: - - ```sh - curl -X POST -u : -H "Content-Type: application/json" -d '{ "message": "Hello, world!", "phoneNumbers": ["79990001234", "79995556677"] }' https://sms.capcom.me/api/3rdparty/v1/message - ``` diff --git a/web/mkdocs/docs/index.md b/web/mkdocs/docs/index.md deleted file mode 100644 index 18d47ea..0000000 --- a/web/mkdocs/docs/index.md +++ /dev/null @@ -1,55 +0,0 @@ -# Android SMS Gateway - -
- Logo -
- -Android SMS Gateway turns your Android smartphone into an SMS gateway. It's a lightweight application that allows you to send SMS messages programmatically via an API. This makes it ideal for integrating SMS functionality into your own applications or services. - -

- -## Features - -- **No registration required:** No registration or email is required to create an account. In local mode, you don't need an account at all! -- **Send SMS via API:** Use our API to send messages directly from your applications or services. -- **Support for Android 5.0 and above:** The application is compatible with Android 5.0 and later versions. -- **Message status tracking:** Monitor the status of sent messages in real-time. -- **Automatic startup:** The application starts running as soon as your device boots up. -- **Support for multiple SIM cards:** The application supports devices with multiple SIM cards. -- **Multipart messages:** The application supports sending long messages with auto-partitioning. -- **End-to-end encryption:** The application provides end-to-end encryption by encrypting message content and recipients' phone numbers before sending them to the API and decrypting them on the device. -- **Message expiration:** The application allows setting an expiration time for messages. Messages will not be sent if they have expired. -- **Random delay between messages:** Introduces a random delay between sending messages to avoid mobile operator restrictions. -- **Private server support:** The application allows for the use of a backend server in the user's infrastructure for enhanced security. - -## Ideal For - -- Notifications -- Alerts -- Two-factor authentication codes - -Android SMS Gateway offers a convenient and reliable solution for sending notifications, alerts, or two-factor authentication codes. - -*Note*: It is not recommended to use this for batch sending due to potential mobile operator restrictions. - -## Project Stage - -The project is currently in the active development stage. We are actively working on adding more features and improving the existing ones. However, some projects already use it in production. - -## 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/index.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 deleted file mode 100644 index 61781e8..0000000 --- a/web/mkdocs/docs/installation.md +++ /dev/null @@ -1,29 +0,0 @@ -# Installation - -The recommended way to install the application is from a prebuilt APK. - -## Prerequisites - -The app requires an Android device with Android 5.0 (Lollipop) or later. - -### Permissions - -Grant the following permissions for full functionality: - -- **SEND_SMS**: Essential for sending SMS messages. -- **READ_PHONE_STATE**: Allows SIM card selection, if utilized. - -## Installing from APK - -1. Visit the [Releases page](https://github.com/capcom6/android-sms-gateway/releases) on GitHub. -2. Select and download the most recent APK. -3. Move the APK file to your Android device. -4. Access **Settings** > **Security** or **Privacy** on your device. -5. Activate **Unknown sources** to allow installations from non-Play Store sources. -6. Use a file manager to find the APK file on your device. -7. Tap the APK to begin installation. -8. Complete the setup as prompted on-screen. - -## Private Server Integration - -For instructions on setting up a private server, refer to [Getting Started - Private Server](./getting-started/private-server.md). \ No newline at end of file diff --git a/web/mkdocs/docs/license.md b/web/mkdocs/docs/license.md deleted file mode 100644 index f49a4e1..0000000 --- a/web/mkdocs/docs/license.md +++ /dev/null @@ -1,201 +0,0 @@ - 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/mkdocs/docs/pricing.md b/web/mkdocs/docs/pricing.md deleted file mode 100644 index eeeafeb..0000000 --- a/web/mkdocs/docs/pricing.md +++ /dev/null @@ -1,29 +0,0 @@ -# Pricing - -The Android SMS Gateway is open-source software and is free to use. We offer three server options for sending messages: - -- **Local Server**: This option allows you to send messages for free, without any restrictions or limitations. - -- **Cloud Server**: Our cloud server provides message sending capabilities that may be subject to certain limitations. If you intend to send more than 1000 messages daily via the cloud server, please contact us for detailed information and potential arrangements. - -- **Private Server**: Using a self-hosted private server gives you the ability to send an unlimited number of messages. However, since push notifications are sent through our cloud server, there is a rate limit on our side. You may need to adjust the notification debounce period in your private server's configuration to accommodate this. - -## Future Guarantees - -- All current features will remain free for existing users indefinitely. -- We might introduce a payment system for new users of the Cloud Server in the future. This will not affect users who have already been using the app. -- New features may be introduced with an associated cost from their initial release. - -## Donations - -If you find value in this project and would like to show your support, please consider making a donation. We currently accept the following cryptocurrencies: - -- Bitcoin (BTC): [bc1q2yntlj495qkazmnmxux786c05p30zlm46tryh4](bitcoin:bc1q2yntlj495qkazmnmxux786c05p30zlm46tryh4) -- TON: [UQD6dfzWZqgcfE10FLPeeaDdUTfXv1TEOau8iwHQJQ0pGT-h](ton://transfer/UQD6dfzWZqgcfE10FLPeeaDdUTfXv1TEOau8iwHQJQ0pGT-h) -- Litecoin (LTC): [ltc1qrke3ys2cph3ttgunyw5799v79ajv9jcexzxc9x](litecoin:ltc1qrke3ys2cph3ttgunyw5799v79ajv9jcexzxc9x) -- Ethereum (ERC20): [0x344B5Ed5229e96dAdcbA300d09Adba55221ab6bA](ethereum:0x344B5Ed5229e96dAdcbA300d09Adba55221ab6bA) -- Binance Coin (BEP20): [0x9372EE7879C48c0da27ce2244F97d49ECC216a8c](binance:0x9372EE7879C48c0da27ce2244F97d49ECC216a8c) - -Donations are primarily used to cover infrastructure costs. We are deeply thankful for your support. - -For any additional questions or for further clarification, please do not hesitate to [contact us](mailto:i@capcom.me). diff --git a/web/mkdocs/docs/privacy/encryption.md b/web/mkdocs/docs/privacy/encryption.md deleted file mode 100644 index 7ac2107..0000000 --- a/web/mkdocs/docs/privacy/encryption.md +++ /dev/null @@ -1,243 +0,0 @@ -# Encryption - -The application supports end-to-end encryption by encrypting message text and recipients' phone numbers before sending them to the API and decrypting them on the device. This ensures that no one – including us as the service provider, the hosting provider, or any third parties – can access the content and recipients of the messages. - -Please note that using encryption will increase device battery usage. - -## Requirements - -1. Fields `message` and every value in the `phoneNumbers` field must be encrypted. -2. The `isEncrypted` field of the message object must be set to `true`. -3. On the device, the same passphrase must be specified as in step 1. - -## Algorithm - -1. Select a passphrase that will be used for encryption and specify it on the device. -2. Generate a random salt, with 16 bytes being the recommended size. -3. Create a secret key using the PBKDF2 algorithm with SHA1 hash function, key size of 256 bits, and recommended iteration count of 75,000. -4. Encrypt the message text and recipients' phone numbers using the AES-256-CBC algorithm and encode the result as Base64. -5. Format result as `$aes-256-cbc/pbkdf2-sha1$i=$$`. The format is inspired by [PHC](https://github.com/P-H-C/phc-string-format/blob/master/phc-sf-spec.md). - -Or use one of the following realization: - -### [PHP](https://github.com/capcom6/android-sms-gateway-php/blob/master/src/Encryptor.php) - -```php -class Encryptor { - protected string $passphrase; - protected int $iterationCount; - - /** - * Encryptor constructor. - * @param string $passphrase Passphrase to use for encryption - * @param int $iterationCount Iteration count - */ - public function __construct( - string $passphrase, - int $iterationCount = 75000 - ) { - $this->passphrase = $passphrase; - $this->iterationCount = $iterationCount; - } - - public function Encrypt(string $data): string { - $salt = $this->generateSalt(); - $secretKey = $this->generateSecretKeyFromPassphrase($this->passphrase, $salt, 32, $this->iterationCount); - - return sprintf( - '$aes-256-cbc/pbkdf2-sha1$i=%d$%s$%s', - $this->iterationCount, - base64_encode($salt), - openssl_encrypt($data, 'aes-256-cbc', $secretKey, 0, $salt) - ); - } - - public function Decrypt(string $data): string { - list($_, $algo, $paramsStr, $saltBase64, $encryptedBase64) = explode('$', $data); - - if ($algo !== 'aes-256-cbc/pbkdf2-sha1') { - throw new \RuntimeException('Unsupported algorithm'); - } - - $params = $this->parseParams($paramsStr); - if (empty($params['i'])) { - throw new \RuntimeException('Missing iteration count'); - } - - $salt = base64_decode($saltBase64); - $secretKey = $this->generateSecretKeyFromPassphrase($this->passphrase, $salt, 32, intval($params['i'])); - - return openssl_decrypt($encryptedBase64, 'aes-256-cbc', $secretKey, 0, $salt); - } - - protected function generateSalt(int $size = 16): string { - return random_bytes($size); - } - - protected function generateSecretKeyFromPassphrase( - string $passphrase, - string $salt, - int $keyLength = 32, - int $iterationCount = 300000 - ): string { - return hash_pbkdf2('sha1', $passphrase, $salt, $iterationCount, $keyLength, true); - } - - /** - * @return array - */ - protected function parseParams(string $params): array { - $keyValuePairs = explode(',', $params); - $result = []; - foreach ($keyValuePairs as $pair) { - list($key, $value) = explode('=', $pair, 2); - $result[$key] = $value; - } - return $result; - } -} -``` - -### TypeScript - -Please note, that Bun's implementation of `crypto` package is not optimized, so it is much slower than Node's implementation. - -```typescript -import crypto from "crypto"; - -class Encryptor { - constructor(protected readonly passphrase: string, protected readonly iterations: number = 75_000) { - - } - - public Decrypt(input: string): string { - const parts = input.split("$"); - if (parts.length !== 5) { - throw new Error("Invalid encrypted text"); - } - - if (parts[1] !== "aes-256-cbc/pbkdf2-sha1") { - throw new Error("Unsupported algorithm"); - } - - const paramsStr = parts[2]; - const params = this.parseParams(paramsStr); - if (!params.has("i")) { - throw new Error("Missing iteration count"); - } - - const iterations = parseInt(params.get("i")!); - const salt = Buffer.from(parts[3], "base64"); - const encryptedText = Buffer.from(parts[4], "base64"); - - const secretKey = this.generateSecretKeyFromPassphrase(this.passphrase, salt, 32, iterations); - const decryptedText = this.decryptString(encryptedText, secretKey, salt); - - return decryptedText.toString("utf8"); - } - - protected parseParams(params: string): Map { - const keyValuePairs = params.split(","); - - const result = new Map(); - keyValuePairs.forEach(pair => { - const [key, value] = pair.split("="); - result.set(key, value); - }); - return result; - } - - protected decryptString(input: Buffer, secretKey: Buffer, iv: Buffer): Buffer { - const decipher = crypto - .createDecipheriv("aes-256-cbc", secretKey, iv); - return Buffer.concat([decipher.update(input), decipher.final()]); - } - - public Encrypt(input: string): string { - const salt = this.generateSalt(); - const secretKey = this.generateSecretKeyFromPassphrase(this.passphrase, salt, 32, this.iterations); - const encryptedText = this.encryptString(Buffer.from(input, "utf8"), secretKey, salt); - return `$aes-256-cbc/pbkdf2-sha1$i=${this.iterations}$${salt.toString("base64")}$${encryptedText.toString("base64")}`; - } - - protected encryptString(input: Buffer, secretKey: Buffer, iv: Buffer): Buffer { - const cypher = crypto - .createCipheriv("aes-256-cbc", secretKey, iv); - - return Buffer.concat([cypher.update(input), cypher.final()]); - } - - protected generateSalt(size: number = 16): Buffer { - return crypto.randomBytes(size); - } - - protected generateSecretKeyFromPassphrase(passphrase: string, salt: Buffer, keyLength: number = 32, iterations: number = 75_000): Buffer { - return crypto.pbkdf2Sync(passphrase, salt, iterations, keyLength, "sha1"); - } -} -``` - -### Python - -Based on [pycryptodome](https://pypi.org/project/pycryptodome/) - -```python -from Crypto.Cipher import AES -from Crypto.Hash import SHA1 -from Crypto.Protocol.KDF import PBKDF2 -from Crypto.Random import get_random_bytes -from Crypto.Util.Padding import pad, unpad - -class AESEncryptor(BaseEncryptor): - def encrypt(self, cleartext: str) -> str: - saltBytes = self._generate_salt() - key = self._generate_key(saltBytes, self.iterations) - - cipher = AES.new(key, AES.MODE_CBC, iv=saltBytes) - - encrypted_bytes = cipher.encrypt(pad(cleartext.encode(), AES.block_size)) - - salt = base64.b64encode(saltBytes).decode("utf-8") - encrypted = base64.b64encode(encrypted_bytes).decode("utf-8") - - return f"$aes-256-cbc/pbkdf2-sha1$i={self.iterations}${salt}${encrypted}" - - def decrypt(self, encrypted: str) -> str: - chunks = encrypted.split("$") - - if len(chunks) < 5: - raise ValueError("Invalid encryption format") - - if chunks[1] != "aes-256-cbc/pbkdf2-sha1": - raise ValueError("Unsupported algorithm") - - params = self._parse_params(chunks[2]) - if "i" not in params: - raise ValueError("Missing iteration count") - - iterations = int(params["i"]) - salt = base64.b64decode(chunks[-2]) - encrypted_bytes = base64.b64decode(chunks[-1]) - - key = self._generate_key(salt, iterations) - cipher = AES.new(key, AES.MODE_CBC, iv=salt) - - decrypted_bytes = unpad(cipher.decrypt(encrypted_bytes), AES.block_size) - - return decrypted_bytes.decode("utf-8") - - def _generate_salt(self) -> bytes: - return get_random_bytes(16) - - def _generate_key(self, salt: bytes, iterations: int) -> bytes: - return PBKDF2( - self.passphrase, - salt, - count=iterations, - dkLen=32, - hmac_hash_module=SHA1, - ) - - def _parse_params(self, params: str) -> t.Dict[str, str]: - return {k: v for k, v in [p.split("=") for p in params.split(",")]} -``` \ No newline at end of file diff --git a/web/mkdocs/docs/privacy/policy.md b/web/mkdocs/docs/privacy/policy.md deleted file mode 100644 index 0033934..0000000 --- a/web/mkdocs/docs/privacy/policy.md +++ /dev/null @@ -1,23 +0,0 @@ -# Privacy - -We are committed to transparency and the protection of user privacy. This document outlines how we handle information within our app. - -## Local Server - -- **No Data Sent to Cloud**: The app functions autonomously, without transmitting any data to cloud servers. -- **Public IP Retrieval**: The sole external network request is made to [ipify](https://www.ipify.org) to retrieve your public IP address. No personal data is disclosed in this process. - -## Cloud Server - -- **Encrypted Communication**: All communication between the app and the cloud server is protected with secure encryption protocols, safeguarding your data during transit. -- **End-to-End Encryption**: Optional AES-based end-to-end encryption is available. With this enabled, messages and phone numbers are encrypted prior to being sent to the API. Consequently, data is encrypted on transmission and only decrypted on the user's device when sending the SMS. This ensures that no entity, including us as the service provider, the hosting provider, or any intermediaries, can access message contents or recipient details. -- **Message Handling**: If end-to-end encryption is not utilized, the message content and recipient information are transformed into a SHA256 hash within 15 minutes of device acknowledgment, preventing the storage of this information in plain text. -- **Limited Data Sharing**: Only necessary data such as device manufacturer, model, app version, and Firebase Cloud Messaging (FCM) token are shared with the server to facilitate cloud services. - -## Private Server - -- **Push Notifications**: Push notifications are routed through the cloud server. These notifications carry solely the device's FCM token and omit any information regarding SMS content or recipients. - -## No Collection of Usage Statistics - -- **No Tracking**: We abstain from collecting any usage statistics, including crash reports. Your interaction with the app remains confidential and unmonitored. diff --git a/web/mkdocs/fonts/Roboto-Black.ttf b/web/mkdocs/fonts/Roboto-Black.ttf deleted file mode 100644 index 0112e7d..0000000 Binary files a/web/mkdocs/fonts/Roboto-Black.ttf and /dev/null differ diff --git a/web/mkdocs/fonts/Roboto-BlackItalic.ttf b/web/mkdocs/fonts/Roboto-BlackItalic.ttf deleted file mode 100644 index b2c6aca..0000000 Binary files a/web/mkdocs/fonts/Roboto-BlackItalic.ttf and /dev/null differ diff --git a/web/mkdocs/fonts/Roboto-Bold.ttf b/web/mkdocs/fonts/Roboto-Bold.ttf deleted file mode 100644 index 43da14d..0000000 Binary files a/web/mkdocs/fonts/Roboto-Bold.ttf and /dev/null differ diff --git a/web/mkdocs/fonts/Roboto-BoldItalic.ttf b/web/mkdocs/fonts/Roboto-BoldItalic.ttf deleted file mode 100644 index bcfdab4..0000000 Binary files a/web/mkdocs/fonts/Roboto-BoldItalic.ttf and /dev/null differ diff --git a/web/mkdocs/fonts/Roboto-Italic.ttf b/web/mkdocs/fonts/Roboto-Italic.ttf deleted file mode 100644 index 1b5eaa3..0000000 Binary files a/web/mkdocs/fonts/Roboto-Italic.ttf and /dev/null differ diff --git a/web/mkdocs/fonts/Roboto-Light.ttf b/web/mkdocs/fonts/Roboto-Light.ttf deleted file mode 100644 index e7307e7..0000000 Binary files a/web/mkdocs/fonts/Roboto-Light.ttf and /dev/null differ diff --git a/web/mkdocs/fonts/Roboto-LightItalic.ttf b/web/mkdocs/fonts/Roboto-LightItalic.ttf deleted file mode 100644 index 2d277af..0000000 Binary files a/web/mkdocs/fonts/Roboto-LightItalic.ttf and /dev/null differ diff --git a/web/mkdocs/fonts/Roboto-Medium.ttf b/web/mkdocs/fonts/Roboto-Medium.ttf deleted file mode 100644 index ac0f908..0000000 Binary files a/web/mkdocs/fonts/Roboto-Medium.ttf and /dev/null differ diff --git a/web/mkdocs/fonts/Roboto-MediumItalic.ttf b/web/mkdocs/fonts/Roboto-MediumItalic.ttf deleted file mode 100644 index fc36a47..0000000 Binary files a/web/mkdocs/fonts/Roboto-MediumItalic.ttf and /dev/null differ diff --git a/web/mkdocs/fonts/Roboto-Regular.ttf b/web/mkdocs/fonts/Roboto-Regular.ttf deleted file mode 100644 index ddf4bfa..0000000 Binary files a/web/mkdocs/fonts/Roboto-Regular.ttf and /dev/null differ diff --git a/web/mkdocs/fonts/Roboto-Thin.ttf b/web/mkdocs/fonts/Roboto-Thin.ttf deleted file mode 100644 index 2e0dee6..0000000 Binary files a/web/mkdocs/fonts/Roboto-Thin.ttf and /dev/null differ diff --git a/web/mkdocs/fonts/Roboto-ThinItalic.ttf b/web/mkdocs/fonts/Roboto-ThinItalic.ttf deleted file mode 100644 index 084f9c0..0000000 Binary files a/web/mkdocs/fonts/Roboto-ThinItalic.ttf and /dev/null differ diff --git a/web/mkdocs/mkdocs.yml b/web/mkdocs/mkdocs.yml deleted file mode 100644 index 4e9983f..0000000 --- a/web/mkdocs/mkdocs.yml +++ /dev/null @@ -1,61 +0,0 @@ -site_name: Android SMS Gateway -site_url: https://sms.capcom.me -repo_url: https://github.com/capcom6/android-sms-gateway -theme: - name: material - features: - - content.code.copy - palette: - # Palette toggle for automatic mode - - media: "(prefers-color-scheme)" - toggle: - icon: material/brightness-auto - name: Switch to light mode - - # Palette toggle for light mode - - media: "(prefers-color-scheme: light)" - scheme: default - - toggle: - icon: material/brightness-7 - name: Switch to dark mode - - # Palette toggle for dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - toggle: - icon: material/brightness-4 - name: Switch to system preference -nav: - - Home: index.md - - Installation: installation.md - - Getting Started: - - Overview: getting-started/index.md - - Local Server: getting-started/local-server.md - - Public Cloud Server: getting-started/public-cloud-server.md - - Private Server: getting-started/private-server.md - - API: api.md - - Pricing: pricing.md - - Privacy: - - Policy: privacy/policy.md - - Encryption: privacy/encryption.md - - FAQ: - - General: faq/general.md - - Errors: faq/errors.md - - Contributing: contributing.md - - License: license.md -validation: - omitted_files: warn - absolute_links: warn - unrecognized_links: warn -plugins: - - search - - render_swagger - - minify: - minify_html: true - minify_js: true - minify_css: true - htmlmin_opts: - remove_comments: true - cache_safe: true - - social diff --git a/web/mkdocs/requirements.txt b/web/mkdocs/requirements.txt deleted file mode 100644 index 3fa206e..0000000 --- a/web/mkdocs/requirements.txt +++ /dev/null @@ -1,5 +0,0 @@ -mkdocs==1.5.3 -mkdocs-material==9.4.8 -mkdocs-material-extensions==1.3 -mkdocs-minify-plugin==0.7.1 -mkdocs-render-swagger-plugin==0.1.1