# Self-host slskd

> A modern web client and server for the Soulseek peer to peer network, with a REST API.

- Page: https://levelrail.com/templates/slskd/
- JSON: https://levelrail.com/templates/slskd.json
- Category: Media
- Licence: AGPL-3.0-only (Network copyleft (AGPL) license)
- Source: https://github.com/slskd/slskd
- Upstream docs: https://github.com/slskd/slskd

## Requirements
- Memory: about 256 MiB
- amd64: unknown, arm64: unknown
- Needs configuration before start: yes
- Pinned image tag: 0.26.2

## Services

| Service | Image | Tag | Ports | Volumes |
| --- | --- | --- | --- | --- |
| slskd | slskd/slskd | 0.26.2 | 5030 | app -> /app |

## Environment

| Service | Variable | Kind |
| --- | --- | --- |
| slskd | SLSKD_PASSWORD | generated |
| slskd | SLSKD_REMOTE_CONFIGURATION | preset |
| slskd | SLSKD_SLSK_PASSWORD | required |
| slskd | SLSKD_SLSK_USERNAME | required |
| slskd | SLSKD_USERNAME | preset |

## Deploy

### CLI

```bash
levelrail-cli templates install slskd --name my-slskd --env SLSK_USERNAME=VALUE --env SLSK_PASSWORD=VALUE
```

Add --domain SERVICE=HOST to serve a service on your own domain, for example --domain slskd=app.example.com.

### API

```bash
curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  https://levelrail.example.com/api/v1/service-templates/slskd/install \
  -d '{
    "name": "my-slskd",
    "env": { "SLSK_USERNAME": "VALUE", "SLSK_PASSWORD": "VALUE" }
  }'
```

Create a token in the dashboard first. Name, env and domains are the request fields.

## First run
1. Sign in as admin with the generated web password.

## Questions

### Can I deploy slskd on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for slskd, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image slskd/slskd:0.26.2 is what you deploy there.

Self-host slskd, slskd docker compose file, deploy slskd on a VPS: this page lists the pinned image, ports, volumes and the commands for each.
