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

fix further links in documentation

Browse Source
This commit is contained in:
mahula 2023-11-09 13:40:49 +01:00
parent 419c5414aa
commit 6a96406b92
5 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
deployment/README.md
View File

@ -39,7 +39,7 @@ Fork this repository to configure and rebrand it for your own [ocelot.social](ht
Write your own data into the main configuration file: Write your own data into the main configuration file:
- [package.json](./package.json) - [package.json](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/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`. 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`.
@ -71,7 +71,7 @@ For the maintenance page have a look in your browser at `http://localhost:5000/`
### Push Changes To GitHub ### 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. 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. 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.
@ -100,9 +100,9 @@ See the login details and browser addresses above.
### Deployment ### Deployment
Afterwards you can [deploy](./deployment/deployment.md) it on your server: Afterwards you can [deploy](./deployment.md) it on your server:
- [Kubernetes with Helm](./deployment/src/kubernetes/README.md) - [Kubernetes with Helm](./src/kubernetes/README.md)
## Developer Chat ## Developer Chat
@ -131,7 +131,7 @@ Browser compatibility testing with [BrowserStack](https://www.browserstack.com/)
## License ## License
See the [LICENSE](./LICENSE.md) file for license rights and limitations (MIT). See the [LICENSE](../LICENSE.md) file for license rights and limitations (MIT).
We need `DOCKER_BUILDKIT=0` for this to work. We need `DOCKER_BUILDKIT=0` for this to work.

4
deployment/deployment.md
View File

@ -4,14 +4,14 @@ Before you start the deployment you have to do preparations.
## Deployment 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`. 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](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/package.json) file as your `dockerOrganisation`.
Read more details in the [main README](./README.md) under [Usage](./README.md#usage). Read more details in the [main README](./README.md) under [Usage](./README.md#usage).
## Deployment Methods ## Deployment Methods
You have the following options for a deployment: You have the following options for a deployment:
- [Kubernetes with Helm](./kubernetes/README.md) - [Kubernetes with Helm](./src/kubernetes/README.md)
## After Deployment ## After Deployment

6
deployment/src/kubernetes/DigitalOcean.md
View File

@ -68,17 +68,17 @@ Take one of the IPs of perhaps two or more droplets in your cluster from the lis
To understand what makes sense to do when managing your DNS with DigitalOcean, you need to know how DNS works: To understand what makes sense to do when managing your DNS with DigitalOcean, you need to know how DNS works:
DNS means `Domain Name System`. It resolves domains like `example.com` into an IP like `123.123.123.123`. DNS means `Domain Name System`. It resolves domains like `example.com` into an IP like `123.123.123.123`.
DigitalOcean is not a domain registrar, but provides a DNS management service. If you use DigitalOcean's DNS management service, you can configure [your cluster](/deployment/kubernetes/README.md#dns) to always resolve the domain to the correct IP and automatically update it for that. DigitalOcean is not a domain registrar, but provides a DNS management service. If you use DigitalOcean's DNS management service, you can configure [your cluster](./README.md#dns) to always resolve the domain to the correct IP and automatically update it for that.
The IPs of the DigitalOcean machines are not necessarily stable, so the cluster's DNS service will update the DNS records managed by DigitalOcean to the new IP as needed. The IPs of the DigitalOcean machines are not necessarily stable, so the cluster's DNS service will update the DNS records managed by DigitalOcean to the new IP as needed.
***CAUTION:** If you are using an external DNS, you currently have to do this manually, which can cause downtime.* ***CAUTION:** If you are using an external DNS, you currently have to do this manually, which can cause downtime.*
## Deploy ## Deploy
Yeah, you're done here. Back to [Deployment with Helm for Kubernetes](/deployment/src/kubernetes/README.md). Yeah, you're done here. Back to [Deployment with Helm for Kubernetes](./README.md).
## Backups On DigitalOcean ## Backups On DigitalOcean
You can and should do [backups](/deployment/kubernetes/Backup.md) with Kubernetes for sure. You can and should do [backups](./Backup.md) with Kubernetes for sure.
Additional to backup and copying the Neo4j database dump and the backend images you can do a volume snapshot on DigitalOcean at the moment you have the database in sleep mode. Additional to backup and copying the Neo4j database dump and the backend images you can do a volume snapshot on DigitalOcean at the moment you have the database in sleep mode.

6
deployment/src/kubernetes/README.md
View File

@ -9,7 +9,7 @@ Please contact us if you are interested in options not listed below.
Managed Kubernetes: Managed Kubernetes:
- [DigitalOcean](/deployment/src/kubernetes/DigitalOcean.md) - [DigitalOcean](./DigitalOcean.md)
## Configuration ## Configuration
@ -165,7 +165,7 @@ $ doctl compute firewall get <ID> --context <context-name>
***ATTENTION:** This seems not to work at all so we leave it away at the moment* ***ATTENTION:** This seems not to work at all so we leave it away at the moment*
***TODO:** I thought this is necessary if we use the DigitalOcean DNS management service? See [Manage DNS With DigitalOcean](/deployment/kubernetes/DigitalOcean.md#manage-dns-with-digitalocean)* ***TODO:** I thought this is necessary if we use the DigitalOcean DNS management service? See [Manage DNS With DigitalOcean](./DigitalOcean.md#manage-dns-with-digitalocean)*
This chart is only necessary (recommended is more precise) if you run DigitalOcean without load balancer. This chart is only necessary (recommended is more precise) if you run DigitalOcean without load balancer.
You need to generate an access token with read + write for the `dns.values.yaml` at <https://cloud.digitalocean.com/account/api/tokens> and fill it in. You need to generate an access token with read + write for the `dns.values.yaml` at <https://cloud.digitalocean.com/account/api/tokens> and fill it in.
@ -280,7 +280,7 @@ helm uninstall ocelot \
## Backups ## Backups
You can and should do [backups](/deployment/kubernetes/Backup.md) with Kubernetes for sure. You can and should do [backups](./Backup.md) with Kubernetes for sure.
## Error Reporting ## Error Reporting

2
deployment/src/old/volumes/neo4j-offline-backup/README.md
View File

@ -23,7 +23,7 @@ So, all we have to do is edit the kubernetes deployment of our Neo4J database
and set a custom `command` every time we have to carry out tasks like backup, and set a custom `command` every time we have to carry out tasks like backup,
restore, seed etc. restore, seed etc.
First bring the application into [maintenance mode](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/deployment/ocelot-social/maintenance/README.md) to ensure there are no First bring the application into [maintenance mode](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/webapp/maintenance/README.md#maintenance-mode) to ensure there are no
database connections left and nobody can access the application. database connections left and nobody can access the application.
Run the following: Run the following: