mirror of
https://github.com/Myzel394/kleckrelay-docs.git
synced 2025-06-18 15:35:28 +02:00
fix: Improve self host section
This commit is contained in:
parent
3a9bf64b47
commit
bfa5bcc1e8
@ -1,7 +1,9 @@
|
|||||||
---
|
---
|
||||||
sidebar_position: 1
|
sidebar_position: 3
|
||||||
title: Config Generator
|
title: Config Generator
|
||||||
---
|
---
|
||||||
import ConfigGenerator from "../../src/components/ConfigGeneratorFeatures/ConfigGenerator";
|
import ConfigGenerator from "../../src/components/ConfigGeneratorFeatures/ConfigGenerator";
|
||||||
|
|
||||||
|
Enter your configuration options below to generate a configuration file for your project.
|
||||||
|
|
||||||
<ConfigGenerator />
|
<ConfigGenerator />
|
||||||
|
@ -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):
|
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
|
### 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.
|
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:
|
Here's an example, you will need to change at least the passwords and the domain name:
|
||||||
|
|
||||||
|
@ -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.
|
|
||||||
:::
|
|
||||||
|
30
docs/self-host/notes.md
Normal file
30
docs/self-host/notes.md
Normal file
@ -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.
|
||||||
|
:::
|
Loading…
x
Reference in New Issue
Block a user