go-chat

Go Chat

It's a simple chat system using a PUB/SUB single channel and GPG encryption. Any message sent from a client ( publisher ) is routed to each other client ( subscriber ) on demand.

• Go Chat
  • How-to
  • Configure
  • Usage
    • Binaries
    • Docker
    • Build from source
  • Support 💛
  • Contributing 🤝
  • Issues

How-to

All messages are encrypted using GPG and the public key of the recipient. The encrypted message is then sent to the server and routed to the recipient. The recipient then decrypts the message using their private key.

             ┌────────┐                  ┌────────┐
Message ─────► Client │                  │ Client ├──Decrypt──►
             └───┬────┘                  └────▲───┘
                 │                            │
                 │           ┌────────┐       │
                 └─Encrypt───► Server ├───────┘
                             └────────┘

Configure

You need to have some environment variables set up. You can do this by creating a .env file in the root of the project. See the example:

PORT=
HOST=
PUBLIC_KEY_FILE=
PRIVATE_KEY_FILE=
PASSPHRASE=

To separate the server from the client, you can use the START_MODE variable. This can be set to either server or client. If it is set to server, the server will start. If it is set to client, the client will start.

Note: You should escape any special characters for the PASSPHRASE.

Usage

Binaries

Download the latest release from the releases page based on your operating system and architecture.

Server:

START_MODE=server ./go-chat-linux-amd64

Client:

Configure your .env file and then run the following command:

START_MODE=client ./go-chat-linux-amd64

Note: For MacOS, you should allow the application to run. You can do this by going to System Preferences > Security & Privacy > General and then click Open Anyway.

Docker

I think we don't need a Docker image for the Client. But if you want to run the Server in a Docker container, you can use the published image.

docker run -it hatamiarash7/go-chat-server

Use PORT and HOST environment variables to configure the server.

docker run -it -e PORT=1234 -e HOST=0.0.0.0 hatamiarash7/go-chat-server

Note: Default PORT is 12345 and default HOST is 0.0.0.0 for Docker.

Build from source

To build the application from source, run the build target:

make build

First, you should build you need to start the server. You can do this by running the following command:

make server

Then, you can run any number of clients. You can do this by running the following command:

make client

Note that you should set required environment variables before running the client.

Support 💛

Contributing 🤝

Don't be shy and reach out to us if you want to contribute 😉

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request

Issues

Each project may have many problems. Contributing to the better development of this project by reporting them. 👍