Skip to content
master
Switch branches/tags
Go to file
Code

README.md

Smithereen

Federated, ActivityPub-compatible social network with friends, walls, and (at some point in the future) groups.

At the moment, this is very far from being production-ready. Things may and likely will break.

If you have any questions or feedback, there's a Telegram chat you can join.

Building/installation

Running directly on your server

  1. Install and configure MySQL
  2. Install maven if you don't have it already
  3. Build the jar by running mvn package and place the one with dependencies at /opt/smithereen/smithereen.jar
  4. Set up the native library (libvips and JNI bindings): pick a binary for your OS and CPU from prebuilt ones or build your own
  5. Install and configure imgproxy
  6. Fill in the config file, see a commented example here
  7. Create a new MySQL database and initialize it with the schema using a command (mysql -p smithereen < schema.sql) or any GUI like phpMyAdmin
  8. Run java -jar /opt/smithereen/smithereen.jar /etc/smithereen/config.properties init_admin to create the first account
  9. Log into that account from your web browser, then configure the rest of the server settings from its UI

Using Docker

Copy Docker-specific config example to the project root directory as config.properties and edit it to set your domain. Also edit docker-compose.yml to add your imgproxy secrets. You can then use docker-compose to run Smithereen, MySQL, and imgproxy. You still need to configure your web server to reverse proxy the port 4567. Create the first account by running docker exec -it smithereen_web_1 bash -c ./smithereen-init-admin.

About

Federated, ActivityPub-compatible social network server with friends, walls, and groups.

Topics

Resources

License

Releases

No releases published

Packages

No packages published