Skip to content

Added user flag to docker run command #1512

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: stable
Choose a base branch
from
Open

Added user flag to docker run command #1512

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,20 +117,24 @@ On Linux, you can deploy smp and xftp server using Docker. This will download im

- `smp-server`

You must change **your_ip_or_domain**. `-e "pass=password"` is optional variable to password-protect your `smp` server:
- You must change **your_ip_or_domain**.
- `-e "pass=password"` is an optional variable, used to password-protect your `smp` server.
- You should run the container as a non-root user (`-u "non_root_user_id"`), since this is the most effective mitigation against privilege escalation vulnerabilities.
```sh
docker run -d \
-e "ADDR=your_ip_or_domain" \
-e "PASS=password" \
-p 5223:5223 \
-v $HOME/simplex/smp/config:/etc/opt/simplex:z \
-v $HOME/simplex/smp/logs:/var/opt/simplex:z \
-u "non_root_user_id"
simplexchat/smp-server:latest
```

- `xftp-server`

You must change **your_ip_or_domain** and **maximum_storage**.
- You must change **your_ip_or_domain** and **maximum_storage**.
- You should run the container as a non-root user (`-u "non_root_user_id"`), since this is the most effective mitigation against privilege escalation vulnerabilities.
```sh
docker run -d \
-e "ADDR=your_ip_or_domain" \
Expand All @@ -139,6 +143,7 @@ On Linux, you can deploy smp and xftp server using Docker. This will download im
-v $HOME/simplex/xftp/config:/etc/opt/simplex-xftp:z \
-v $HOME/simplex/xftp/logs:/var/opt/simplex-xftp:z \
-v $HOME/simplex/xftp/files:/srv/xftp:z \
-u "non_root_user_id"
simplexchat/xftp-server:latest
```

Expand Down Expand Up @@ -188,20 +193,24 @@ On Linux, you can build smp server using Docker.

- `smp-server`

You must change **your_ip_or_domain**. `-e "pass=password"` is optional variable to password-protect your `smp` server:
- You must change **your_ip_or_domain**.
- `-e "pass=password"` is an optional variable, used to password-protect your `smp` server.
- You should run the container as a non-root user (`-u "non_root_user_id"`), since this is the most effective mitigation against privilege escalation vulnerabilities.
```sh
docker run -d \
-e "ADDR=your_ip_or_domain" \
-e "PASS=password" \
-p 5223:5223 \
-v $HOME/simplex/smp/config:/etc/opt/simplex:z \
-v $HOME/simplex/smp/logs:/var/opt/simplex:z \
-u "non_root_user_id"
simplexchat/smp-server:latest
```

- `xftp-server`

You must change **your_ip_or_domain** and **maximum_storage**.
- You must change **your_ip_or_domain** and **maximum_storage**.
- You should run the container as a non-root user (`-u "non_root_user_id"`), since this is the most effective mitigation against privilege escalation vulnerabilities.
```sh
docker run -d \
-e "ADDR=your_ip_or_domain" \
Expand All @@ -210,6 +219,7 @@ On Linux, you can build smp server using Docker.
-v $HOME/simplex/xftp/config:/etc/opt/simplex-xftp:z \
-v $HOME/simplex/xftp/logs:/var/opt/simplex-xftp:z \
-v $HOME/simplex/xftp/files:/srv/xftp:z \
-u "non_root_user_id"
simplexchat/xftp-server:latest
```

Expand Down