This repository is an in use template to rebrand, configure, and deploy ocelot.social networks. The forked original repository is stage.ocelot.social.
Try out our deployed development environment.
Visit our staging networks:
- central staging network: stage.ocelot.social
Logins:
| password | role | |
|---|---|---|
user@example.org |
1234 | user |
moderator@example.org |
1234 | moderator |
admin@example.org |
1234 | admin |
Fork this repository to configure and rebrand it for your own ocelot.social network.
Write your own data into the main configuration file:
Since all deployment methods described here depend on Docker and DockerHub, you need to create your own organisation on DockerHub and put its name in the package.json file as your dockerOrganisation.
The next step is:
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 initThe database is then initialised with the default administrator:
- E-mail: admin@example.org
- 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/.
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 publish 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:
- Named
DOCKERHUB_TOKENwith the newly created DockerHub token (only the code, not the token name). - Named
DOCKERHUB_USERNAMEwith your DockerHub username.
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.ymlwith your network name - in the file, rename the ocelot.social DockerHub organisation
ocelotsocialnetworkto 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 initSee the login details and browser addresses above.
Afterwards you can deploy it on your server:
Join our friendly open-source community on Discord 😻
Just introduce yourself at #introduce-yourself and mention @@Mentor to get you onboard 
Check out the contribution guideline, too!
We give write permissions to every developer who asks for it. Just text us on Discord.
See the LICENSE file for license rights and limitations (MIT).
We need DOCKER_BUILDKIT=0 for this to work.