Skip to content

Commit

Permalink
[general] introduce new domain
Browse files Browse the repository at this point in the history
  • Loading branch information
capcom6 committed Sep 14, 2024
1 parent df972c4 commit a3fea39
Show file tree
Hide file tree
Showing 9 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/faq/general.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ To send an SMS using a non-default SIM card, you can specify the SIM card slot n
curl -X POST \
-u <username>:<password> \
-H 'content-type: application/json' \
https://sms.capcom.me/api/3rdparty/v1/message \
https://api.sms-gate.app/3rdparty/v1/message \
-d '{
"message": "Hello from SIM2",
"phoneNumbers": ["79990001234"],
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The Android SMS Gateway can operate in three distinct modes, all utilizing the same API:

1. [**Local Server**](./local-server.md): Operate entirely within your local network by running the server on your Android device. This mode is perfect for quick setups with no need for Internet access. For remote access, you may need to configure your network settings and implement additional security measures.
2. [**Public Cloud Server**](./public-cloud-server.md): Easily connect via the Internet using the public server at `sms.capcom.me`. Messages are routed through this server to your devices, simplifying the setup without requiring network adjustments. This mode is suitable for non-sensitive data only. For more secure communication, please refer to the [end-to-end encryption section](../privacy/encryption.md).
2. [**Public Cloud Server**](./public-cloud-server.md): Easily connect via the Internet using the public server at `sms-gate.app`. Messages are routed through this server to your devices, simplifying the setup without requiring network adjustments. This mode is suitable for non-sensitive data only. For more secure communication, please refer to 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 will not have access to your message content, making this the preferred option for sensitive communication. However, this option requires setting up and maintaining your own infrastructure, including a database and server application.

To begin with any of these modes, you must first install the Android SMS Gateway app on your device, as described in the [Installation](../installation.md) section.
Expand All @@ -12,4 +12,4 @@ For more details on how to use the API, please consult the [API](../integration/

## Building Your Own Gateway

Building your own gateway is an option that allows you to create an independent infrastructure without any connection to the public server at `sms.capcom.me`. In most cases, this is not necessary, and you can use the [Private Server](./private-server.md) mode with all of its privacy features. However, if you require full control, please see [Custom Gateway Setup](./custom-gateway.md) section.
Building your own gateway is an option that allows you to create an independent infrastructure without any connection to the public server at `sms-gate.app`. In most cases, this is not necessary, and you can use the [Private Server](./private-server.md) mode with all of its privacy features. However, if you require full control, please see [Custom Gateway Setup](./custom-gateway.md) section.
2 changes: 1 addition & 1 deletion docs/getting-started/private-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<img src="/assets/private-server-arch.png" alt="Architecture of the Private Server mode">
</div>

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.
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-gate.app`. 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

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/public-cloud-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ Use the cloud server mode when dealing with dynamic or shared device IP addresse
curl -X POST -u <username>:<password> \
-H "Content-Type: application/json" \
-d '{ "message": "Hello, world!", "phoneNumbers": ["+79990001234", "+79995556677"] }' \
https://sms.capcom.me/api/3rdparty/v1/message
https://api.sms-gate.app/3rdparty/v1/message
```
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,12 @@ This project is licensed under the [Apache License 2.0](license.md).
If you have any questions or suggestions, feel free to reach out through the following channels:

- **Issue Tracker:** [https://github.com/capcom6/android-sms-gateway/issues](https://github.com/capcom6/android-sms-gateway/issues)
- **Email:** [sms@capcom.me](mailto:sms@capcom.me)
- **Email:** [support@sms-gate.app](mailto:support@sms-gate.app)
- **Discord:** [Join our Discord server](https://discord.gg/vv9raFK4gX)

### Links

- **Website:** [https://sms.capcom.me](https://sms.capcom.me)
- **Website:** [https://sms-gate.app](https://sms-gate.app)
- **Project:** [https://github.com/android-sms-gateway](https://github.com/android-sms-gateway)
- **Main Repository:** [https://github.com/capcom6/android-sms-gateway](https://github.com/capcom6/android-sms-gateway)
- **Author GitHub:** [capcom6](https://github.com/capcom6)
6 changes: 3 additions & 3 deletions docs/integration/webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ To start receiving webhook notifications, you must register your webhook endpoin
curl -X POST -u <username>:<password> \
-H "Content-Type: application/json" \
-d '{ "id": "<unique-id>", "url": "https://webhook.site/<your-uuid>", "event": "sms:received" }' \
https://sms.capcom.me/api/3rdparty/v1/webhooks
https://api.sms-gate.app/3rdparty/v1/webhooks
```

Replace `<username>`, `<password>`, `<unique-id>`, and `<your-uuid>` with your actual credentials and information.
Expand All @@ -56,7 +56,7 @@ You can verify that it has been successfully registered by executing the followi

```sh
curl -X GET -u <username>:<password> \
https://sms.capcom.me/api/3rdparty/v1/webhooks
https://api.sms-gate.app/3rdparty/v1/webhooks
```

Please note that webhooks registered in Local mode are separate from those registered in Cloud/Private mode. Therefore, when you make this request to the device's local server, you will only see the webhooks registered in Local mode, and similarly, a request to the Cloud/Private server will only show the webhooks registered there.
Expand Down Expand Up @@ -93,7 +93,7 @@ If you no longer wish to receive webhook notifications, deregister your webhook

```sh
curl -X DELETE -u <username>:<password> \
'https://sms.capcom.me/api/3rdparty/v1/webhooks/%3Cunique-id%3E'
'https://api.sms-gate.app/3rdparty/v1/webhooks/%3Cunique-id%3E'
```

## Security Considerations
Expand Down
2 changes: 1 addition & 1 deletion docs/pricing.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ If you find value in this project and would like to show your support, please co

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:sms@capcom.me).
For any additional questions or for further clarification, please do not hesitate to [contact us](mailto:support@sms-gate.app).
2 changes: 1 addition & 1 deletion docs/resources/usages.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Usages

In this section, you will find links to projects that utilize the SMS Gateway for Android. All of these projects were discovered on the internet through publicly available information. If you would like to add your project or have a project listed that you would like to remove, please [contact us](mailto:sms@capcom.me).
In this section, you will find links to projects that utilize the SMS Gateway for Android. All of these projects were discovered on the internet through publicly available information. If you would like to add your project or have a project listed that you would like to remove, please [contact us](mailto:support@sms-gate.app).

### Open Source

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
site_name: SMS Gateway for Android™
site_url: https://sms.capcom.me
site_url: https://sms-gate.app
repo_url: https://github.com/capcom6/android-sms-gateway
theme:
name: material
Expand Down

0 comments on commit a3fea39

Please sign in to comment.