|
1 | | -# Setup Guide for Signal |
2 | | -On this repository, you will find guides about Signal Setup that might help people who want to run their own signal server. |
3 | | - |
4 | | -## Disclaimer |
5 | | -This repository is not an official Signal Guide and there is no relation to the team behind Signal. It's just a guide written outside my work-time to help people. |
6 | | - |
7 | | -These guides are provided as-is, please refer to Issue section of this readme file for more information regarding this guide. |
8 | | - |
9 | | -Please do not contact me through my personal line or social media. |
10 | | - |
11 | | -## Requirements |
12 | | -* SSL Certificate of your server's domain (For secure communication) |
13 | | -* Google Recaptcha (For anti-spam in authentication) |
14 | | -* Firebase (For push notification) |
15 | | -* Twilio (For SMS OTP & Voice Call) |
16 | | -* AWS S3 & Cloudfront (For Attachments & CDN. Can be subtituted with MinIO & LocalStack) |
17 | | -* AWS SQS (For CDS queue) |
18 | | -* AWS DynamoDB (For nosql database) |
19 | | -* Micrometer (For monitoring) |
20 | | -* Fixer (For payment) |
21 | | - |
22 | | -## Content |
23 | | -What's proven works |
24 | | -* [Signal Server v2.92](./signal-server-2.92/) |
25 | | -* [Signal Server v3.21](./signal-server-3.21/) |
26 | | -* [Signal Server v4.xx](./signal-server-4.xx/) |
27 | | -* [Signal Server v5.xx](./signal-server-5.xx/) |
28 | | -* [Signal Android](./signal-android/) |
29 | | -* [Signal IOS](./signal-ios/) |
30 | | -* [Signal Desktop](./signal-desktop/) |
31 | | -* [Signal Dependency on Docker (Postgres & Redis)](./signal-docker/) |
32 | | -* [Voice/Video Call (CoTurn)](./coturn-server/) |
33 | | -* [Port Forwarding (Nginx)](./signal-server-2.92/example-nginx.conf) |
34 | | -* [Signal Server with AWS S3 CDN & SQS](./signal-server-aws-setup/) |
35 | | -* [Signal Server v2.92 with MinIO CDN](./signal-minio/) |
36 | | -* [Signal Server v3.21 with MinIO CDN (Improvement & Cleaner)](./signal-server-3.21/MINIO.md) |
37 | | -* [Signal Server Autostart Script](./signal-server-autostart/) |
38 | | -* [Signal Server With Self Signed Certificate for Localhost](./signal-server-self-signed-certificate/) |
39 | | -* [Signal Server Without Twilio](./signal-server-no-twilio/) |
40 | | -* [Signal Server OTP With smsgateway.me](./signal-server-no-twilio/twillo%20replacement%20with%20smsgateway.me) |
41 | | - |
42 | | -What's not proven work |
43 | | -* [Contact Discovery Service (CDS)](./signal-server-2.92/example-cds.yml), you still can use your signal server without CDS. If you want to implement CDS, please refer to [ the guide written by @konglomerat-id here](https://github.com/secure-sign/securesign-setup-guide) |
44 | | - |
45 | | -## Updating |
46 | | -If you have do some modification to your code and want to get update from the official git repo, you can follow [UPDATING](./UPDATING.md) |
47 | | - |
48 | | -## FAQ |
49 | | -Q: Will I be able to do ... with Signal? |
50 | | - |
51 | | -A: My suggestion is first you need to setup normal signal server and check if it will fulfill your need. |
52 | | - |
53 | | -Q: My chat only goes one way or can't send chat even when the server already set properly. |
54 | | - |
55 | | -A: Probably caused by keystore haven't contain your SSL certificate / certificate did not match the url / you have not setup the Unidentified Delivery properly in the client. Will be explained in each guide of the server & clients. |
56 | | - |
57 | | -Q: How to setup Turn Server? I can't do voice/video call. |
58 | | - |
59 | | -A: Probably related to your port, either it is not allowed by the firewall or it is not properly set. See my example config on [Coturn Server](./coturn-server/example-turnserver.conf) |
60 | | - |
61 | | -Q: Can I subtitute AWS to MinIO? |
62 | | - |
63 | | -A: I tried it here [signal-minio](./signal-minio/) using modification created by <a href="https://community.signalusers.org/t/amazon-s3-component-replacement-for-text-secure-server-local-installation/5375/18">kondal789rao |
64 | | -</a>. Someone also did a pull request here: <a href="https://github.com/signalapp/signal-server-2.92/pull/76">Use MinIO instead of the AWS</a>. Also you can try to look into <a href="https://github.com/localstack/localstack">Localstack</a> for local development. |
65 | | - |
66 | | -Q: Can I disable / change Twilio? (by getting the generated OTP on the server) |
67 | | - |
68 | | -A: Yes, it is possible, you need to change TwilioSmsSender Class, see example on [Signal Server Without Twilio](./signal-server-no-twilio/). |
69 | | - |
70 | | -Q: Can I use Signal in localhost / internal IP / self-signed certificate (by trusting all certificate) |
71 | | - |
72 | | -A: Yes, it is possible but it is not secure, see example on [Signal Server Self Signed Certificate](./signal-server-self-signed-certificate/). |
73 | | - |
74 | | -Q: Can I remove Google Mobile Service (GMS) from Signal? |
75 | | - |
76 | | -A: Yes! A Signal user named "tx-hw" did it on their <a href="https://github.com/tw-hx/Signal-Android/tree/4.60.5.0-FOSS">Github Fork of Signal-Android</a>. You can read more about it on their <a href="https://community.signalusers.org/t/ive-removed-gms-from-the-signal-website-build-its-now-completely-open-source/14382">Signal Community Post</a> |
77 | | - |
78 | | -## Contributor |
79 | | -This guide has been written by the help of the developers from community. |
80 | | - |
81 | | -* [konglomerat-id](https://github.com/on-premise-signal/signal-setup-guide) wrote the configuration and steps to setup signal server 2.55 |
82 | | -* [LiteSpeedDev](https://github.com/LiteSpeedDev/SignalApp-Setup) wrote nginx configuration and turn/stun server |
83 | | -* [kondal789rao](https://community.signalusers.org/t/amazon-s3-component-replacement-for-text-secure-server-local-installation/5375/18) modified AWS to MinIO. |
84 | | -* [madeindra](https://github.com/madeindra/setup-guide) compiled the guide, improve the steps, and wrote more guide on uncovered topics |
85 | | -* [sinholic](https://github.com/sinholic) wrote iOS guide |
86 | | -* [amargarido](https://github.com/amargarido) helped to improve the readme |
87 | | -* [jacob-pro ](https://github.com/jacob-pro) added v4.xx guide & helped improving v5.xx |
88 | | -* [tronbiniyam](https://github.com/tronbiniyam) added sms otp subtitute to use to replace Twilio |
89 | | - |
90 | | -You are welcome to contribute on this guide, please fork the repository and create a Pull Request. |
91 | | - |
92 | | -## Issue |
93 | | -If you have any questions please create a discussion instead of issue. |
94 | | - |
95 | | -You are recommended to <a href="https://github.com/madeindra/setup-guide/discussions/new">open a discussion thread here</a> if you face a difficulties to let the communities help you too and contributing to the communities in the process. |
| 1 | +# Unmaintained |
| 2 | +Please refer to [Signal Community](https://community.signalusers.org) for any help regarding Signal server & client setup. |
0 commit comments