Installation guide

Patchwork is a framework to add a suite of plug-ins to a Mastodon server, creating layers between the underlying plumbing of Mastodon and the frontend app used by a user to access it (usually also Mastodon).

Before running Patchwork, please ensure you have set up a Mastodon server and it is running properly.

You can find the instructions to set up a Mastodon server here.

Patchwork begins with the Dashboard.

Once your Mastodon server is up and running, please begin with this repository to set up the Patchwork Dashboard.

This is the core of Patchwork’s frame, introducing new features itself to make your server more powerful, and allowing you to install additional Patchwork plug-ins with ease.

Dashboard installation guide

Please follow the simple steps below to install Patchwork Dashboard:

1. Clone this repository (Patchwork Dashboard) in your server:

git clone git@github.com:patchwork-hub/patchwork_dashboard.git

2. Create .env file by copying the .env.sample file:

cp .env.sample .env

3. Read the comments mentioned in the ENV file thoroughly and configure the environment accordingly.

4. Install the gems:

bundle install

5. Run database migrations:

bundle exec rails db:migrate

5. Import required data and create a master admin account:

bundle exec rails db:seed

6. Start your server(change the port number according to your need):

bundle exec rails s -p 3002

To fully activate your Patchwork Dashboard, add an API key by following below steps:

1. Generate an API key 1.1 Go to Patchwork Hub, register a new account and verify it. 1.2 Once you have verified it, generate an API key on the landing page of the Patchwork Hub.

2. Add the generated API key in your Patchwork Dashboard 2.1 Login to your Patchwork Dashboard with the master admin account. 2.2 On the left-side menu, click the "API key". 2.3 In the API key page, add the Key and Secret values generated from the Patchwork Hub. 2.4 After entering the credential, the Patchwork Dashboard is fully activated.

Next, expand your server's capabilities by installing plug-ins.

Choose from this list:

• Content filters
• Advanced post features

Content filters

Filter timelines with defined hashtags & keywords, and manage your server's connection to Threads & Bluesky.

1. Add this line to your Mastodon application's Gemfile:

gem "content_filters", git: "https://github.com/patchwork-hub/content_filters"

2. Execute to install the gem:

$ bundle install

3. After installing the gem, restart your application to load it in your application.

Advanced post features

Give users on your server advanced posting options, including custom character limits and text formatting.

1. Add this line to your Mastodon application's Gemfile:

gem "posts", git: "https://github.com/patchwork-hub/posts"

2. Install The gem

bundle install

3. After installing the gem, restart your application to load it in your application.