Add docs for DockerHub

README.md

@@ -28,9 +28,61 @@ Logins:
 
 ## Usage
 
-Fork this repository and configure as well as rebrand it for your own [ocelot.social](/branding/README.md) network.
+Fork this repository to configure and rebrand it for your own [ocelot.social](https://github.com/Ocelot-Social-Community/Ocelot-Social) network.
 
-- [Configure And Rebrand](https://github.com/Ocelot-Social-Community/Ocelot-Social-Deploy-Rebranding/tree/master/branding)
+### Package.Json And DockerHub Organisation
+
+Write your own data into the main configuration file:
+
+- [package.json](/package.json)
+
+Since all deployment methods described here depend on [Docker](https://docker.com) and [DockerHub](https://hub.docker.com), you need to create your own organisation on DockerHub and put its name in the [package.json](/package.json) file as your `dockerOrganisation`.
+
+### Configure And Branding
+
+The next step is:
+
+- [Configure And Branding](/branding/README.md)
+
+### Proof Configuration And Branding Locally
+
+Just in case you have Docker installed and run the following, you can check your branding locally:
+
+```bash
+# 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: admin@example.org
+- Password: 1234
+
+To check your pushed Docker images in your organisation's DockerHub repositories, rename the file `docker-compose.ocelotsocial-branded.yml` with your network name, remove any local Docker images if necessary, and do the following:
+
+```bash
+# 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 above.
+
+### 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 [publish](/.github/workflows/publish.yml) 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.
+
+### Deployment
 
 Afterwards you can [deploy](/deployment/README.md) it on your server:
 
@@ -47,9 +99,9 @@ We give write permissions to every developer who asks for it. Just text us on
 
 ## Technology Stack
 
+- [Docker](https://www.docker.com)
 - [Kubernetes](https://kubernetes.io)
 - [Helm](https://helm.sh)
-- [Docker](https://www.docker.com)
 
 <!--
 ## Attributions

branding/README.md

@@ -1,4 +1,4 @@
-# Configure And Rebranding
+# Configure And Branding
 
 In this folder you will find all configuration files and logo images to customise the configuration and branding of the [ocelot.social](https://github.com/Ocelot-Social-Community/Ocelot-Social) network code to your own needs.
 

deployment/README.md

@@ -1,5 +1,14 @@
 # Deployment
 
+Before you start the deployment you have to do preparations.
+
+## Deployment Preparations
+
+Since all deployment methods described here depend on [Docker](https://docker.com) and [DockerHub](https://hub.docker.com), you need to create your own organisation on DockerHub and put its name in the [package.json](/package.json) file as your `dockerOrganisation`.  
+Read more details in the [main README](/README.md) under [Usage](/README.md#usage).
+
+## Deployment Methods
+
 You have the following options for a deployment:
 
 - [Kubernetes with Helm](./kubernetes/README.md)

package.json

@@ -1,7 +1,7 @@
 {
   "name": "ocelot-social-branded",
-  "version": "1.0.3",
-  "ocelotDockerVersionTag": "1.0.3-97",
+  "version": "1.0.4",
+  "ocelotDockerVersionTag": "1.0.4-100",
   "dockerOrganisation": "ocelotsocialnetwork",
   "description": "ocelot.social Branded",
   "author": "ocelot.social Community",