This will build a Docker image for [SoulSeek](https://slsknet.org, to allow it to be accessed via a web browser.
- About
- Maintainer
- Table of Contents
- Prerequisites and Assumptions
- Installation
- Configuration
- Maintenance
- Support
- License
- References
Clone this repository and build the image with docker build <arguments> (imagename) .
Builds of the image are available on Docker Hub
Builds of the image are also available on the Github Container Registry
docker pull ghcr.io/tiredofit/docker-soulseek:(imagetag)
The following image tags are available along with their tagged release based on what's written in the Changelog:
| Debian Base | Tag |
|---|---|
| latest | :latest |
docker pull docker.io/tiredofit/soulseek:(imagetag)Images are built primarily for amd64 architecture, and may also include builds for arm/v7, arm64 and others. These variants are all unsupported. Consider sponsoring my work so that I can work with various hardware. To see if this image supports multiple architecures, type docker manifest (image):(tag)
-
The quickest way to get started is using docker-compose. See the examples folder for a working docker-compose.yml that can be modified for development or production use.
-
Set various environment variables to understand the capabilities of this image.
-
Map persistent storage for access to configuration and data files for backup.
-
Make networking ports available for public access if necessary
The following directories are used for configuration and can be mapped for persistent storage.
| Directory | Description |
|---|---|
/data/ |
Data files such as application data and logs |
/www/logs |
Logfiles for Nginx error and Access |
This image relies on an Alpine Linux or Debian Linux base image that relies on an init system for added capabilities. Outgoing SMTP capabilities are handlded via msmtp. Individual container performance monitoring is performed by zabbix-agent. Additional tools include: bash,curl,less,logrotate, nano.
Be sure to view the following repositories to understand all the customizable options:
| Image | Description |
|---|---|
| OS Base | Customized Image based on Alpine Linux |
| OS Base | Customized Image based on Debian Linux |
| Nginx | Nginx webserver image based on either of the above OS |
| NoVNC | NoVNC image which allows remote connectivity to GUI apps via a web browser |
For debugging and maintenance purposes you may want access the containers shell.
bash docker exec -it (whatever your container name is) bash
These images were built to serve a specific need in a production environment and gradually have had more functionality added based on requests from the community.
- The Discussions board is a great place for working with the community on tips and tricks of using this image.
- Consider sponsoring me for personalized support
- Please, submit a Bug Report if something isn't working as expected. I'll do my best to issue a fix in short order.
- Feel free to submit a feature request, however there is no guarantee that it will be added, or at what timeline.
- Consider sponsoring me regarding development of features.
- Best effort to track upstream changes, More priority if I am actively using the image in a production environment.
- Consider sponsoring me for up to date releases.
MIT. See LICENSE for more details.