soundcloak/README.md

soundcloak

wip alternative frontend for soundcloud

Instance list

Already implemented

• Searching for songs, users, playlists
• Basic user overview (songs, playlists, albums, reposts, metadata)
• Basic song overview (author, metadata) & streaming (requires some JS if instance has Restream disabled)
• Basic playlist/set/album overview (songs list, author, metadata)
• Resolving shortened links (https://on.soundcloud.com/boiKDP46fayYDoVK9 -> https://sc.maid.zone/on/boiKDP46fayYDoVK9)
• Content proxying (images, audio)
• View featured tracks, playlists
• Users can change their preferences (should proxying be enabled, what method of playing the song should be used etc)

In the works

• Track player embeds (https://w.soundcloud.com/player/ -> https://sc.maid.zone/w/player/)

The UI isn't really done yet. All parameters other than url are unsupported. You can also specify track without the soundcloud.com part: https://sc.maid.zone/w/player/?url=<id> or https://sc.maid.zone/w/player/?url=<user>/<track>

Viewing instance settings

If the instance isn't outdated and has InstanceInfo setting enabled, you can navigate to <instance>/_/info to view useful instance settings. (sc.maid.zone/_/info for example)

An easier way is to navigate to <instance>/_/preferences.

If some features are disabled by the instance, they won't show up there.

Available features:

• Parse descriptions: Highlight @username, https://example.com and email@example.com in text as clickable links
• Proxy images: Retrieve images through the instance, instead of going to soundcloud's servers for them
• Player: In what way should the track be streamed. Can be Restream (does not require JS, better compatibility, can be a bit buggy client-side) or HLS (requires JS, more stable, less good compatibility (you'll be ok unless you are using a very outdated browser))
• Player-specific settings: They will only show up if you have selected HLS player currently.
• • Proxy streams: Retrieve song pieces through the instance, instead of going to soundcloud's servers for them
• • Fully preload track: Fully loads the track when you load the page instead of buffering a small part of it

Contributing

Contributions are appreciated! This includes feedback, feature requests, issues, pull requests and etc. Feedback and feature requests are especially needed, since I (laptopcat) don't really know what to prioritize

You can contribute on:

• GitHub
• Codeberg (mirror)

You can also reach out to me privately

Setting it up

1. Regular method

Prerequisites:

1. node.js + npm (any recent enough version should do, it's just used for getting hls.js builds)
2. golang (1.21 or higher was tested, others might work too)
3. git

Setup:

1. Clone this repository:

git clone https://github.com/maid-zone/soundcloak

2. Go into the cloned repository:

cd soundcloak

3. Download hls.js:

npm i

4. Download templ:

go install github.com/a-h/templ/cmd/templ@latest

You might need to add go binaries to your PATH (add this line to your .bashrc / .zshrc / whatever)

export PATH=${PATH}:`go env GOPATH`/bin

5. Generate code from templates:

templ generate

6. Download other required go modules:

go get

7. Optional. Edit config:

You can make a soundcloak.json file in the folder with the binary if you want, or an environment variable SOUNDCLOAK_CONFIG with path to the config. Refer to lib/cfg/init.go for configuration values and their meaning.

8. Build binary:

go build main.go

9. Run the binary:

./main

This will run soundcloak on localhost, port 4664. (by default)

2. Docker image

The docker image was made by vlnst

Prerequisites:

1. Docker
2. Git

Setup:

1. Clone this repository:

git clone https://github.com/maid-zone/soundcloak

2. Go into the cloned repository:

cd soundcloak

3. Make a copy of the example compose.yaml file:

cp compose.example.yaml compose.yaml

Make adjustments as needed.

4. Optional. Edit config:

You can make a soundcloak.json file in the folder if you want. Refer to soundcloak.json.example and lib/cfg/init.go for configuration values and their meaning.

5. Run the container

docker compose up -d

(if you get docker: 'compose' is not a docker command., use docker-compose up -d)

This will run soundcloak as a daemon (remove the -d part of the command to just run it) on localhost, port 4664. (by default)

Maintenance-related stuffs

Updating

Note: this guide works only if you install from source. If you used docker, you could probably do the 1st step (pulling the code), stop the container (docker container stop soundcloak) and start it again. (docker compose up -d)

1. Retrieve the latest code:

git fetch origin
git pull

2. Remove compressed versions of files:

The webserver is configured to locally cache compressed versions of files. They have .fiber.gz extension and can be found in assets folder and node_modules/hls.js/dist. If any static files have been changed, you should purge these compressed files so the new versions can be served. Static files are also cached in user's browser, so you will need to clean your cache to get the new files (Ctrl + F5)

For example, you can clean these files from assets folder like so:

cd assets
rm *.fiber.gz

3. Optional. Edit config:

Sometimes, new updates add new config values or change default ones. You can make a soundcloak.json file in the folder with the binary if you want, or an environment variable SOUNDCLOAK_CONFIG with path to the config. Refer to soundcloak.json.example and lib/cfg/init.go for configuration values and their meaning.

4. Regenerate templates (if they changed):

templ generate

5. Get latest Go modules:

go get

6. Update hls.js:

npm i

7. Build binary:

go build main.go

8. Run it:

./main

Congratulations! You have succesfully updated your soundcloak.

Built with

Backend

• Go programming language
• Fiber (v2)
• templ
• fasthttp

Frontend

• HTML, CSS and JavaScript
• hls.js