Files
soundcloak/docs/USER_GUIDE.md
2024-12-23 12:05:05 +02:00

1.9 KiB

Instances List

Viewing instance settings

If the instance is in the instances list, then you can view a few of the settings there (ProxyStreams, ProxyImages, Restream)

You can also visit <instance>/_/info to view some of the settings. This endpoint is only available if InstanceInfo is enabled by the maintainer.

Example output: (from soundcloak.fly.dev/_/info)

{
  "Commit": "9126705",
  "Repo": "https://github.com/maid-zone/soundcloak",
  "ProxyImages": true,
  "ProxyStreams": true,
  "Restream": true,
  "GetWebProfiles": true,
  "DefaultPreferences": {
    "Player": "restream",
    "ProxyStreams": true,
    "FullyPreloadTrack": false,
    "ProxyImages": true,
    "ParseDescriptions": true,
    "AutoplayNextTrack": false,
    "DefaultAutoplayMode": "normal",
    "HLSAudio": "mpeg",
    "RestreamAudio": "mpeg",
    "DownloadAudio": "mpeg",
    "ShowAudio": true
  }
}

Preferences

Click the "Preferences" button on the main page, or navigate to <instance>/_/preferences to get started.

Instance maintainers can set their own default preferences.

Refer to here for a full list of preferences. If you don't see certain preferences on the page, it means that you have to enable a different preference to configure this one, or this feature has been disabled on the backend.

Those preferences are saved in a cookie.

Management

Scroll down to the end of the preferences page. There you can see a management tab for preferences. You can export your preferences as a JSON file, import the preferences, or reset them.

Redirecting from SoundCloud to soundcloak

soundcloak tries to keep the URL schemes same to SoundCloud's, so you can just replace soundcloud.com with your instance URL. For short links: https://on.soundcloud.com/boiKDP46fayYDoVK9 -> <instance>/on/boiKDP46fayYDoVK9