Skip to main content

Ocelot.Social Deploy And Rebranding

About 2 min

Ocelot.Social Deploy And Rebranding

Build Status Publishopen in new windowMIT Licenseopen in new windowDiscord Channelopen in new windowOpen Source Helpersopen in new window

This repository is an in use template to rebrand, configure, and deploy ocelot.socialopen in new window networks. The forked original repository is stage.ocelot.socialopen in new window.

Live demo

Try out our deployed development environmentopen in new window.

Visit our staging networks:




Fork this repository to configure and rebrand it for your own ocelot.socialopen in new window network.

Package.Json And DockerHub Organisation

Write your own data into the main configuration file:

Since all deployment methods described here depend on Dockeropen in new window and DockerHubopen in new window, you need to create your own organisation on DockerHub and put its name in the package.jsonopen in new window file as your dockerOrganisation.

Configure And Branding

The next step is:

Optional: Locally Testing Configuration And Branding

Just in case you have Docker installed and run the following, you can check your branding locally:

# in main folder
$ docker-compose up
# fill the database with an initial admin
$ docker-compose exec backend yarn run prod:migrate init

The database is then initialised with the default administrator:

  • E-mail:
  • Password: 1234

For login or registration have a look in your browser at http://localhost:3000/.
For the maintenance page have a look in your browser at http://localhost:5000/.

Push Changes To GitHub

Before merging these changes into the "master" branch on your GitHub fork repository, you need to configure the GitHub repository secrets. This is necessary to publishopen in new window the Docker images by pushing them via GitHub actions to repositories belonging to your DockerHub organisation.

First, go to your DockerHub profile under Account Settings and click on the Security tab. There you create an access token called <your-organisation>-access-token and copy the token to a safe place.

Secondly, in your GitHub repository, click on the 'Settings' tab and go to the 'Secrets' tab. There you create two secrets by clicking on New repository secret:

  1. Named DOCKERHUB_TOKEN with the newly created DockerHub token (only the code, not the token name).
  2. Named DOCKERHUB_USERNAME with your DockerHub username.

Optional: Locally Testing Your DockerHub Images

Just in case you like to check your pushed Docker images in your organisation's DockerHub repositories locally:

  • rename the file docker-compose.ocelotsocial-branded.yml with your network name
  • in the file, rename the DockerHub organisation ocelotsocialnetwork to your organisations name

Remove any local Docker images if necessary and do the following:

# in main folder
$ docker-compose -f docker-compose.<your-organisation>-branded.yml up
# fill the database with an initial admin
$ docker-compose exec backend yarn run prod:migrate init

See the login details and browser addresses above.


Afterwards you can deploy it on your server:

Developer Chat

Join our friendly open-source community on Discordopen in new window 😻 Just introduce yourself at #introduce-yourself and mention @@Mentor to get you onboard :neckbeard: Check out the contribution guidelineopen in new window, too!

We give write permissions to every developer who asks for it. Just text us on Discordopen in new window.

Technology Stack


See the LICENSEopen in new window file for license rights and limitations (MIT).

We need DOCKER_BUILDKIT=0 for this to work.