ocelot-Social-Community/Ocelot-Social
1
0
Fork 0
mirror of https://github.com/Ocelot-Social-Community/Ocelot-Social.git synced 2025-12-13 07:46:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refine docs, first step

Browse Source
This commit is contained in:
Wolfgang Huß 2022-07-08 11:14:18 +02:00
parent b0d04e3c28
commit 45913de805
2 changed files with 28 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -8,14 +8,20 @@
This repository is an in use template to rebrand, configure, and deploy [ocelot.social](https://github.com/Ocelot-Social-Community/Ocelot-Social) networks.
The forked original repository is [Ocelot-Social-Deploy-Rebranding](https://github.com/Ocelot-Social-Community/Ocelot-Social-Deploy-Rebranding).
<!-- markdownlint-disable MD033 -->
<p align="center">
<a href="https://ocelot.social" target="_blank"><img src="branding/static/img/custom/logo-squared.svg" alt="Ocelot-Social" width="40%" height="40%"></a>
</p>
<!-- markdownlint-enable MD033 -->
<!--
## Live demo
__Try out our deployed [development environment](https://develop.human-connection.org/).__
__Try out our deployed [development environment](https://stage.ocelot.social).__
Visit our staging networks:
- central staging network: [stage.ocelot.social](https://stage.ocelot.social).
<!-- - rebranded staging network: [rebrand.ocelot.social](https://stage.ocelot.social). -->
Logins:
@ -24,7 +30,8 @@ Logins:
| `user@example.org` | 1234 | user |
| `moderator@example.org` | 1234 | moderator |
| `admin@example.org` | 1234 | admin |
-->
Deployed networks can be found [here](#list-of-deployed-networks).
## Usage
@ -44,7 +51,7 @@ The next step is:
- [Configure And Branding](/branding/README.md)
### Optional: Proof Configuration And Branding Locally
### Optional: Locally Testing Configuration And Branding
Just in case you have Docker installed and run the following, you can check your branding locally:
@ -74,7 +81,7 @@ Secondly, in your GitHub repository, click on the 'Settings' tab and go to the '
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: Proof DockerHub Images Locally
### Optional: Locally Testing Your DockerHub Images
Just in case you like to check your pushed Docker images in your organisation's DockerHub repositories locally:
@ -123,6 +130,20 @@ Browser compatibility testing with [BrowserStack](https://www.browserstack.com/)
<img alt="BrowserStack Logo" src=".gitbook/assets/browserstack-logo.svg" width="256">
-->
## List Of Deployed Networks
You may need an invitation to access a network.
### More Likely To Try
- [wir.social](https://wir.social)
### Others
- [freilernen.social](https://freilernen.social)
- [helfa.social](https://helfa.social)
- [sender.fm](https://sender.fm)
## License
See the [LICENSE](/LICENSE.md) file for license rights and limitations (MIT).

3
deployment/kubernetes/DigitalOcean.md
View File

@ -18,7 +18,8 @@ On the right top you find the button `Create`. Click on it and choose `Kubernete
- use the latest Kubernetes version
- choose your datacenter region
- name your node pool: e.g. `pool-<your-network-name>`
- 2 `Basic node` with a total of 4GB and 2 shared CPUs are enough to start with
- `2 Basic nodes` with a total of `4 GB` and `2 shared CPUs` are enough to start with
- `2 Basic nodes` with a total of `8 GB` and `2 shared CPUs` are a bit more optimal for the beginning
- no tags necessary
- set your cluster name: e.g. `cluster-<your-network-name>`
- select your project