Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/slskd/slskd
A modern client-server application for the Soulseek file sharing network.
https://github.com/slskd/slskd
hacktoberfest soulseek soulseek-network soulseek-web
Last synced: 3 months ago
JSON representation
A modern client-server application for the Soulseek file sharing network.
- Host: GitHub
- URL: https://github.com/slskd/slskd
- Owner: slskd
- License: agpl-3.0
- Created: 2020-12-30T18:22:48.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-03-19T04:04:07.000Z (3 months ago)
- Last Synced: 2024-03-19T21:07:50.685Z (3 months ago)
- Topics: hacktoberfest, soulseek, soulseek-network, soulseek-web
- Language: C#
- Homepage:
- Size: 7.67 MB
- Stars: 703
- Watchers: 11
- Forks: 44
- Open Issues: 179
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Lists
- project-awesome - slskd/slskd - A modern client-server application for the Soulseek file sharing network. (C# #)
README
# slskd
[](https://github.com/slskd/slskd/actions/workflows/ci.yml)
[](https://hub.docker.com/r/slskd/slskd)
[](https://github.com/slskd/slskd/releases)
[](https://github.com/slskd/slskd/graphs/contributors)
[](https://slskd.org/discord)
[](https://slskd.org/matrix)
A modern client-server application for the [Soulseek](https://www.slsknet.org/news/) file-sharing network.
## Features
### Secure access
slskd runs as a daemon or Docker container in your network (or in the cloud!) and is accessible from a web browser. It's designed to be exposed to the internet, and everything is secured with a token that [you can control](https://github.com/slskd/slskd/blob/master/docs/config.md#authentication). It also supports [reverse proxies](https://github.com/slskd/slskd/blob/master/docs/reverse_proxy.md), making it work well with other self-hosted tools.
### Search
Search for things just like you're used to with the official Soulseek client. slskd makes it easy to enter multiple searches quickly.
### Results
Sort and filter search results using the same filters you use today. Dismiss results you're not interested in, and download the ones you want in a couple of clicks.
### Downloads
Monitor the speed and status of downloads, grouped by user and folder. Click the progress bar to fetch your place in queue, and use the selection tools to cancel, retry, or clear completed downloads. Use the controls at the top to quickly manage downloads by status.
### Pretty much everything else
slskd can do almost everything the official Soulseek client can; browse user shares, join chat rooms, privately chat with other users.
New features are added all the time!
## Quick Start
### With Docker
```shell
docker run -d \
-p 5030:5030 \
-p 5031:5031 \
-p 50300:50300 \
-e SLSKD_REMOTE_CONFIGURATION=true \
-v :/app \
--name slskd \
slskd/slskd:latest
```
### With Docker-Compose
```
---
version: "2"
services:
slskd:
image: slskd/slskd
container_name: slskd
ports:
- "5030:5030"
- "5031:5031"
- "50300:50300"
environment:
- SLSKD_REMOTE_CONFIGURATION=true
volumes:
- :/app
restart: always
```
This command or docker-compose file (depending on your choice) starts a container instance of slskd on ports 5030 (HTTP) and 5031 (HTTPS using a self-signed certificate). slskd begins listening for incoming connections on port 50300 and maps the application directory to the provided path.
Once the container is running you can access the web UI over HTTP on port 5030, or HTTPS on port 5031. The default username and password are `slskd` and `slskd`, respectively. You'll want to change these if the application will be internet facing.
The `SLSKD_REMOTE_CONFIGURATION` environment variable allows you to modify application configuration settings from the web UI. You might not want to enable this for an internet-facing installation.
You can find a more in-depth guide to running slskd in Docker [here](https://github.com/slskd/slskd/blob/master/docs/docker.md).
### With Binaries
The latest stable binaries can be downloaded from the [releases](https://github.com/slskd/slskd/releases) page. Platform-specific binaries and the static content for the Web UI are produced as artifacts from every [build](https://github.com/slskd/slskd/actions?query=workflow%3ACI) if you'd prefer to use a canary release.
Binaries are shipped as zip files; extract the zip to your chosen directory and run.
An application directory will be created in either `~/.local/share/slskd` (on Linux and macOS) or `%localappdata%/slskd` (on Windows). In the root of this directory the file `slskd.yml` will be created the first time the application runs. Edit this file to enter your credentials for the Soulseek network, and tweak any additional settings using the [configuration guide](https://github.com/slskd/slskd/blob/master/docs/config.md).
## Configuration
Once running, log in to the web UI using the default username `slskd` and password `slskd` to complete the configuration.
Detailed documentation for configuration options can be found [here](https://github.com/slskd/slskd/blob/master/docs/config.md), and an example of the YAML configuration file can be reviewed [here](https://github.com/slskd/slskd/blob/master/config/slskd.example.yml).