cl0nebot / soundstorm

Federated Social Audio Platform

Soundstorm

The Federated Social Music Platform.

Soundstorm is an audio-oriented federated social network that speaks ActivityPub. Users can upload their own music, comment on others' tracks, and like/follow/mention just as in a regular social network. Since it speaks the same language as federated platforms like Mastodon, Soundstorm can send new track upload posts to users' followers on the fediverse, allowing them to gain a greater reach than a conventional social audio service.

Installation

Soundstorm is distributed as a Docker image for deployment ease. The reference instance, https://soundstorm.social, uses Amazon ECS for deployment, but the image is self-contained and can be run on any infrastructure. This image runs in RAILS_ENV=production mode by default.

First, pull down the latest version:

docker pull weathermen/soundstorm:latest

Create a .env file in the local dir for your configuration:

SOUNDSTORM_HOST=your.soundstorm.domain
SOUNDSTORM_ADMIN_USERNAME=your-username
SOUNDSTORM_ADMIN_PASSWORD=your-password
[email protected]
#DATABASE_URL=postgres://[email protected]:5432
#REDIS_URL=rediss://[email protected]:6379
CDN_URL=https://cdn.soundstorm.domain
SMTP_USERNAME=your-smtp-server-user
SMTP_PASSWORD=your-smtp-server-password
SMTP_HOST=smtp.server.if.not.using.sendgrid.net

Then, run the setup task:

RAILS_ENV=production bin/soundstorm rails db:setup

This will create the database and set up its schema. You can now start all containers by running the following command:

RAILS_ENV=production bin/soundstorm start

If DNS is set up correctly, you should now be able to access your Soundstorm instance at the domain specified by $SOUNDSTORM_HOST in your .env configuration.

Development

The above goes into installing Soundstorm for real-world use, but you may also want to contribute to the project in some way. For this, it's recommended that you install dependencies locally.

If you're on a Mac, run this command to install hard dependencies:

brew bundle

On Linux, make sure you have the following packages installed:

• libsndfile-dev
• ffmpeg
• nodejs
• yarn

Next, you can run the setup script to install all application dependencies onto your machine:

bin/setup

If you're using puma-dev, the next step would be to link to https://soundstorm.test:

puma-dev link

You should now be able to visit the server and log in with username admin and password Password1!. This is configurable by setting $SOUNDSTORM_ADMIN_USERNAME and $SOUNDSTORM_ADMIN_PASSWORD as environment variables when running bin/setup.

For more information on making contributions to this project, read the [contributing guide][].