christofsteel/syng
christofsteel/syng
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity Actions

Update README

Browse source
This commit is contained in:
Christoph Stahl 2025-02-15 12:11:10 +01:00
parent c3c0176697
commit 607e117325
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -159,12 +159,16 @@ If you want to host your own Syng server, you can do that, but you can also use
You can install the server via pip: You can install the server via pip:
pip install 'syng[server]' pip install syng
and then run via: and then run via:
syng server syng server
The server is also automatically available if you install the client.
There exists one optional dependency for the server: `alt-profanity-check`. If this package is installed, each username is checked for profanity, otherwise no such check happens.
## Docker ## Docker
Alternatively you can run the server using docker. It listens on port 8080 and reads a key file at `/app/keys.txt` when configured as private or restricted. Alternatively you can run the server using docker. It listens on port 8080 and reads a key file at `/app/keys.txt` when configured as private or restricted.