diff --git a/README.md b/README.md index 0586b30d5..4a872beea 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ If you're wondering how you could help, there are plenty of ways, e.g.: - Promote it on your social networks. - Tell your friends about it by word-of-mouth. - Write a press article on ocelot.social or contact the editorial office of your local news page or radio station. -- Take a [good first issue](https://github.com/Ocelot-Social-Community/Ocelot-Social/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or issues that need help. Make sure to read [CONTRIBUTING.md](/CONTRIBUTING.md) first though. +- Take a [good first issue](https://github.com/Ocelot-Social-Community/Ocelot-Social/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or issues that need help. Make sure to read [CONTRIBUTING.md](./CONTRIBUTING.md) first though. - Testing and [reporting](https://github.com/Ocelot-Social-Community/Ocelot-Social/issues/new/choose) bugs. - Translating: Please [contact us](#contact). - Reviewing and testing pull requests. diff --git a/deployment/README.md b/deployment/README.md index 8fdcf48c6..933620564 100644 --- a/deployment/README.md +++ b/deployment/README.md @@ -41,7 +41,7 @@ Write your own data into the main configuration file: - [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](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/package.json) file as your `dockerOrganisation`. ### Configure And Branding @@ -71,7 +71,7 @@ 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 [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](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/.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 `-access-token` and copy the token to a safe place. @@ -100,7 +100,7 @@ See the login details and browser addresses above. ### 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](./src/kubernetes/README.md) diff --git a/deployment/deployment.md b/deployment/deployment.md index 22a38a181..0e808af50 100644 --- a/deployment/deployment.md +++ b/deployment/deployment.md @@ -5,7 +5,7 @@ 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](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](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/README.md) under [Usage](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/README.md#usage). ## Deployment Methods diff --git a/deployment/src/kubernetes/DigitalOcean.md b/deployment/src/kubernetes/DigitalOcean.md index 71c49d783..a2fcae9b9 100644 --- a/deployment/src/kubernetes/DigitalOcean.md +++ b/deployment/src/kubernetes/DigitalOcean.md @@ -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: 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. ***CAUTION:** If you are using an external DNS, you currently have to do this manually, which can cause downtime.* ## 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 -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. diff --git a/deployment/src/kubernetes/README.md b/deployment/src/kubernetes/README.md index 17773d736..d78e1ad26 100644 --- a/deployment/src/kubernetes/README.md +++ b/deployment/src/kubernetes/README.md @@ -9,7 +9,7 @@ Please contact us if you are interested in options not listed below. Managed Kubernetes: -- [DigitalOcean](/deployment/src/kubernetes/DigitalOcean.md) +- [DigitalOcean](./DigitalOcean.md) ## Configuration @@ -165,7 +165,7 @@ $ doctl compute firewall get --context ***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. You need to generate an access token with read + write for the `dns.values.yaml` at and fill it in. @@ -280,7 +280,7 @@ helm uninstall ocelot \ ## 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