Improve documentation with docker compose example.

Open
#1,301 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
52/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
docker, docker-compose
Domain
documentation

Research direction

Review README.md's Linux deployment section and compare the proposed Docker Compose example with the existing docker run instructions. Add the compose.yml setup, configuration notes, startup command, and log commands shown in the issue; done means users can follow the README to run both servers and find their addresses.

Written by the indexing model from the issue text.

Description

I think it would be helpful to have a docker compose example for users. It may be simpler than the docker run example. If you think a docker compose suggestion would be helpful, I provided some recommended documentation for the README.md below:

Deploy SMP/XFTP servers on Linux

Docker Compose

Create a directory of your choice (e.g. ./simplexchat) to hold the compose.yml file.

mkdir ./simplexchat
cd ./simplexchat

Create a compose.yml file with the following contents. Change 1) your_ip_or_domain in both containers 2) "PASS=password" This password cannot contain special characters and 3) maximum_storage to a value such as 2GB.

---
name: simplex
services:
  simplex.smp:
    container_name: simplex.smp
    environment:
      - ADDR=your_ip_or_domain
      - PASS=password
    ports:
      - 5223:5223
    volumes:
      - ./simplex/smp/config:/etc/opt/simplex:z
      - ./simplex/smp/logs:/var/opt/simplex:z
    image: simplexchat/smp-server:latest
    restart: unless-stopped
  simplex.xftp:
    container_name: simplex.xftp
    environment:
      - ADDR=your_ip_or_domain
      - QUOTA=maximum_storage
    ports:
      - 443:443
    volumes:
      - ./simplex/xftp/config:/etc/opt/simplex-xftp:z
      - ./simplex/xftp/logs:/var/opt/simplex-xftp:z
      - ./simplex/xftp/files:/srv/xftp:z
    image: simplexchat/xftp-server:latest
    restart: unless-stopped

Then while in the same folder as the compose.yml run:

docker compose up

Once the container is running, you can find the smp and xftp server address: by viewing the docker logs.

docker logs simplex.smp

docker logs simplex.xftp
Dominant language
Haskell
Stars
847
Forks
111
Avg merge
3d 11h
Merged PRs (30d)
9

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from simplex-chat/simplexmq

All issues in simplex-chat/simplexmq

Similar issues

More Haskell issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.