All apps · 0 apps
binhex-slskd
Docker app from Binhex's Repository
Overview
Readme
View on GitHubApplication
Description
A modern client-server application for the Soulseek file-sharing network.
Build notes
Latest stable slskd release from GitHub.
Usage
docker run -d \
--name=<container name> \
-p <host port for slskd web ui http>:8980 \
-p <host port for slskd web ui https>:8990 \
-v <path for config files>:/config \
-v <path for media files>:/media \
-v <path for data files>:/data \
-v /etc/localtime:/etc/localtime:ro \
-e SLSK_USERNAME=<username> \
-e SLSK_PASSWORD=<password> \
-e SLSK_LISTEN_PORT=<port> \
-e SHARED_PATHS=<paths> \
-e INCOMPLETE_PATH=<path> \
-e DOWNLOADS_PATH=<path> \
-e WEBUI_HTTP_PORT=<port> \
-e WEBUI_HTTPS_PORT=<port> \
-e WEBUI_USERNAME=<username> \
-e WEBUI_PASSWORD=<password> \
-e API_KEY=<api key> \
-e UPLOAD_SPEED_LIMIT=<int32> \
-e DOWNLOAD_SPEED_LIMIT=<int32> \
-e REMOTE_CONFIGURATION=<true|false> \
-e REMOTE_FILE_MANAGEMENT=<true|false> \
-e GLUETUN_INCOMING_PORT=<yes|no> \
-e HEALTHCHECK_COMMAND=<command> \
-e HEALTHCHECK_ACTION=<action> \
-e HEALTHCHECK_HOSTNAME=<hostname> \
-e UMASK=<umask for created files> \
-e PUID=<uid for user> \
-e PGID=<gid for user> \
binhex/arch-slskd
Please replace all user variables in the above command defined by <> with the correct values.
Access slskd Web UI
http://<host ip>:8980
Example
docker run -d \
--name=binhex-slskd \
-p 8980:8980 \
-p 8990:8990 \
-v /home/nobody/config:/config \
-v /home/nobody/media:/media \
-v /home/nobody/data:/data \
-v /etc/localtime:/etc/localtime:ro \
-e SLSK_USERNAME=mysoulseekusername \
-e SLSK_PASSWORD=mysoulseekpassword \
-e UMASK=000 \
-e PUID=99 \
-e PGID=100 \
binhex/arch-slskd
Notes
User ID (PUID) and Group ID (PGID) can be found by issuing the following command for the user you want to run the container as:-
id <username>
API_KEY value must be between 16 and 255 charactes and can be any string you want, to generate a randomised string run openssl rand -hex 16.
If you appreciate my work, then please consider buying me a beer :D
Categories
Download Statistics
Related apps
Explore more like this
Explore allDetails
ghcr.io/binhex/arch-slskdRuntime arguments
- Web UI
http://[IP]:[PORT:8980]- Network
bridge- Shell
bash- Privileged
- false
- Extra Params
--restart=unless-stopped
Template configuration
This is the HTTP Web UI port for the application.
- Target
- 8980
- Default
- 8980
This is the HTTPS Web UI port for the application.
- Target
- 8990
- Default
- 8990
This is the container path to your configuration files, e.g. databases, configuration files, logs etc.
- Target
- /config
- Default
- /mnt/user/appdata/slskd
This is the container path to your media files, e.g. movies, tv, music, pictures etc.
- Target
- /media
- Default
- /mnt/user
This is the container path to your downloaded files or user created content.
- Target
- /data
Username for the Soulseek network.
- Target
- SLSK_USERNAME
Password for the Soulseek network.
- Target
- SLSK_PASSWORD
Port on which to listen for incoming connections.
- Target
- SLSK_LISTEN_PORT
- Default
- 50300
Semi-colon separated list of container paths to shared files. !!WARNING!! Be careful not to share sensitive information.
- Target
- SHARED_PATHS
The container path where incomplete downloads are saved.
- Target
- INCOMPLETE_PATH
- Default
- /data/incomplete
The container path where downloaded files are saved.
- Target
- DOWNLOADS_PATH
- Default
- /data/completed
Upload speed limit in bits/s.
- Target
- UPLOAD_SPEED_LIMIT
- Default
- 2147483647
Download speed limit in bits/s.
- Target
- DOWNLOAD_SPEED_LIMIT
- Default
- 2147483647
HTTP port for web UI.
- Target
- WEBUI_HTTP_PORT
- Default
- 8980
HTTPS port for web UI.
- Target
- WEBUI_HTTPS_PORT
- Default
- 8990
Username for web UI authentication.
- Target
- WEBUI_USERNAME
- Default
- slskd
Password for web UI authentication.
- Target
- WEBUI_PASSWORD
- Default
- slskd
API key for slskd API access, string between 16 and 255 characters, you can use the command 'openssl rand -hex 16' to generate a randomised string.
- Target
- API_KEY
Allow remote configuration (true/false).
- Target
- REMOTE_CONFIGURATION
- Default
- true|false
Allow remote file management (true/false).
- Target
- REMOTE_FILE_MANAGEMENT
- Default
- true|false
Specify whether to attempt to identify and configure the applications listening port when connected to the gluetun network.
- Target
- GLUETUN_INCOMING_PORT
- Default
- no|yes
Specify the port for the gluetun HTTP Control Server.
- Target
- GLUETUN_CONTROL_SERVER_PORT
- Default
- 8000
Specify the username for the gluetun HTTP Control Server
- Target
- GLUETUN_CONTROL_SERVER_USERNAME
- Default
- controlserver
Specify the password for the gluetun HTTP Control Server
- Target
- GLUETUN_CONTROL_SERVER_PASSWORD
- Default
- controlserver
Enable or disable healthchecks.
- Target
- ENABLE_HEALTHCHECK
- Default
- yes|no
The command or script to execute, if not specified then the script healthcheck.sh will be used (process, dns and https checking).
- Target
- HEALTHCHECK_COMMAND
The action to execute if the healthcheck command returns a non zero exit code, if not specified the action will be 'exit 1', if you want the container to exit on failure then set the action to 'kill 1'.
- Target
- HEALTHCHECK_ACTION
The hostname used when performing HTTPS and DNS healthchecking.
- Target
- HEALTHCHECK_HOSTNAME
- Default
- google.com
User ID for the running container
- Target
- PUID
- Default
- 99
Group ID for the running container
- Target
- PGID
- Default
- 100
UMASK for the running container
- Target
- UMASK
- Default
- 000
