https://github.com/howingyip/music-server
Simple tool for downloading and syncing music across multiple devices
https://github.com/howingyip/music-server
docker docker-compose python rsync ssh telegram-bot
Last synced: 13 days ago
JSON representation
Simple tool for downloading and syncing music across multiple devices
- Host: GitHub
- URL: https://github.com/howingyip/music-server
- Owner: HoWingYip
- Created: 2024-09-08T11:39:00.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2025-04-12T09:51:17.000Z (about 1 month ago)
- Last Synced: 2025-05-08T17:55:41.552Z (13 days ago)
- Topics: docker, docker-compose, python, rsync, ssh, telegram-bot
- Language: Python
- Homepage:
- Size: 84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SSH music server
This is a tool for downloading music and syncing it across multiple devices. It consists of an SSH server, SSH tunnel, and Telegram bot. If you have your own internet-facing domain, the tunnel is not required.
## Contents
- [Usage overview](#usage-overview)
- [Configuration](#configuration)
- [SSH server](#ssh-server)
- [SSH tunnel](#ssh-tunnel)
- [Telegram bot](#telegram-bot)
- [Using the Telegram bot](#using-the-telegram-bot)
## Usage overview
1. Install Docker
2. Configure settings
3. On server: `cd music-server && docker compose up`
4. Download songs through Telegram bot
5. On client: `rsync -avz user@remote:/music/ /your/local/music/dir`
## Configuration
To set the host port on which the SSH server is exposed, set `SSH_PORT` in the file `.env`. Example: `SSH_PORT=2002`. Note that `.env` does not define any environment variables; Docker Compose only reads from it to interpolate variables in `compose.yml`.
Configure other settings by setting environment variables in the following files:
- `server/.env.server` for SSH server
- `tunnel/.env.tunnel` for SSH tunnel
- `telegram_bot/.env.bot` for Telegram bot
### SSH server
We inherit from the [`linuxserver/openssh-server`](https://hub.docker.com/r/linuxserver/openssh-server) Docker image. Environment variables go in `server/.env.server`. Available settings are listed [here](https://github.com/linuxserver/docker-openssh-server?tab=readme-ov-file#parameters). Below is an example config:
```bash
# User ID and group ID of SSH user
PUID=1000
PGID=1000
# Server timezone
TZ=Etc/UTC+8
# Folder containing SSH public keys to accept
PUBLIC_KEY_DIR=/config/pub_keys
# Enable/disable password access
PASSWORD_ACCESS=false
# Username of SSH user
USER_NAME=user
# Whether SSH user should be sudo
SUDO_ACCESS=false
# Log to stdout instead of file
LOG_STDOUT=true
```
### SSH tunnel
The author tunnels SSH traffic over an ngrok TCP tunnel because she's poor. Should you choose to do the same, you'll need an ngrok account with a valid payment method added. (At the time of writing, ngrok TCP tunnels are free-of-charge, but require a payment method for abuse prevention.)
Setup is simple. In `tunnel/.env.tunnel`, set `NGROK_AUTHTOKEN=your_ngrok_authtoken`.
If you're hosting your music on an internet-facing server, the SSH tunnel is not necessary. To disable it, comment out the following sections in `compose.yml`:
- `services.ssh-tunnel`
- `services.telegram-bot.depends_on.ssh-tunnel`
### Telegram bot
In `telegram_bot/.env.bot`, set:
```bash
BOT_TOKEN=your_bot_token # Telegram bot token
ALLOWED_USER_IDS=1,2,3 # comma-separated list of Telegram user IDs to allow
```
You can find your user ID by texting [@userinfobot](https://t.me/userinfobot) on Telegram. (The author is not affiliated with this third-party service.)
## Using the Telegram bot
The Telegram bot accepts the following commands:
| Command | Action
|-|-
| `/add_playlist` | Add online playlist contents to local playlist
| `/add_songs` | Add individual songs to local playlist
| `/delete_playlist` | Delete local playlist
| `/delete_songs` | Delete individual songs from local playlist
| `/list_playlists` | List local playlists
| `/list_songs` | List songs in local playlist
| `/rename_playlist` | Rename local playlist
| `/server` | View SSH server address and port
| `/help` | Show manual