From bfa5bcc1e8b94f0f95e911cba78a85e375c78b6e Mon Sep 17 00:00:00 2001 From: Myzel394 <50424412+Myzel394@users.noreply.github.com> Date: Sat, 18 Mar 2023 11:40:48 +0100 Subject: [PATCH] fix: Improve self host section --- docs/self-host/config-generator.mdx | 4 +++- docs/self-host/docker.md | 7 ++++++- docs/self-host/index.md | 28 +-------------------------- docs/self-host/notes.md | 30 +++++++++++++++++++++++++++++ 4 files changed, 40 insertions(+), 29 deletions(-) create mode 100644 docs/self-host/notes.md diff --git a/docs/self-host/config-generator.mdx b/docs/self-host/config-generator.mdx index 4addc8e..28a2e07 100644 --- a/docs/self-host/config-generator.mdx +++ b/docs/self-host/config-generator.mdx @@ -1,7 +1,9 @@ --- -sidebar_position: 1 +sidebar_position: 3 title: Config Generator --- import ConfigGenerator from "../../src/components/ConfigGeneratorFeatures/ConfigGenerator"; +Enter your configuration options below to generate a configuration file for your project. + diff --git a/docs/self-host/docker.md b/docs/self-host/docker.md index 74bc463..a3a7c7d 100644 --- a/docs/self-host/docker.md +++ b/docs/self-host/docker.md @@ -1,5 +1,6 @@ --- -sidebar_position: 1 +sidebar_position: 2 +title: Docker --- KleckRelay requires a total of 3 services to run (this will probably change in future): @@ -14,6 +15,10 @@ This guide assumes you are using Docker and Docker Compose. ### Creating docker-compose.yml +:::tip +Use our [Config Generator](/docs/self-host/config-generator) to generate everything you need. +::: + We will use a separate `.env` file to store sensitive information. This will be shared by multiple services. Here's an example, you will need to change at least the passwords and the domain name: diff --git a/docs/self-host/index.md b/docs/self-host/index.md index 5b516b4..7090582 100644 --- a/docs/self-host/index.md +++ b/docs/self-host/index.md @@ -1,29 +1,3 @@ --- -sidebar_position: 1 +title: Self Hosting KleckRelay --- - -# Self-hosting KleckRelay - -At the moment it's a bit difficult to self-host KleckRelay, but we're working on it. - -However, if you are keen on self-hosting KleckRelay, you can do so by following the instructions below. - -## Hosting the Server (Backend) - -The easiest way to self-host KleckRelay is to use the Docker image. -You will need to use a server that supports port 25, 443 and we strongly recommend you having a static IP address. - -:::tip -We recommend using [Incognet](https://incognet.io/) as a VPS provider. -They offer cheap VPS, static IPs, allow port 25 and allow you to pay in crypto. - -**We are not sponsored by Incognet in anyway. We just like them.** -::: - -KleckRelay should not be exposed to the internet directly, but instead you should use a reverse proxy such as -Nginx or Caddy. - -:::tip -We recommend using [bunkerweb](https://github.com/bunkerity/bunkerweb) as a reverse proxy. -You can use our [tool](#tool) to generate a configuration for bunkerweb. -::: diff --git a/docs/self-host/notes.md b/docs/self-host/notes.md new file mode 100644 index 0000000..b029ae9 --- /dev/null +++ b/docs/self-host/notes.md @@ -0,0 +1,30 @@ +--- +sidebar_position: 1 +title: Important Notes +--- + +# Self-hosting KleckRelay + +At the moment it's a bit difficult to self-host KleckRelay, but we're working on it. + +However, if you are keen on self-hosting KleckRelay, you can do so by following the instructions below. + +## Hosting the Server (Backend) + +The easiest way to self-host KleckRelay is to use the Docker image. +You will need to use a server that supports port 25, 443 and we strongly recommend you having a static IP address. + +:::tip +We recommend using [Incognet](https://incognet.io/) as a VPS provider. +They offer cheap VPS, static IPs, allow port 25 and allow you to pay in crypto. + +**We are not sponsored by Incognet in anyway. We just like them.** +::: + +KleckRelay should not be exposed to the internet directly, but instead you should use a reverse proxy such as +Nginx or Caddy. + +:::tip +We recommend using [bunkerweb](https://github.com/bunkerity/bunkerweb) as a reverse proxy. +You can use our [tool](#tool) to generate a configuration for bunkerweb. +:::