Skip to content

Commit 77bad31

Browse files
DxsSucukgitbook-bot
DxsSucuk
authored and
gitbook-bot
committed
GITBOOK-22: Refine Webinterface section
1 parent 57081fa commit 77bad31

7 files changed

+138
-8
lines changed

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,6 @@ For the Bot you can use this guide:
3939

4040
For the Webinterface you can use this guide below:
4141

42-
{% content-ref url="webinterface/self-hosting.md" %}
43-
[self-hosting.md](webinterface/self-hosting.md)
42+
{% content-ref url="webinterface/self-hosting/" %}
43+
[self-hosting](webinterface/self-hosting/)
4444
{% endcontent-ref %}

‎SUMMARY.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818

1919
* [Self hosting](bot/self-hosting/README.md)
2020
* [Self host with Pterodactyl](bot/self-hosting/self-host-with-pterodactyl.md)
21+
* [Self host with Docker](bot/self-hosting/self-host-with-docker.md)
2122
* [Plugin System](bot/plugin-system/README.md)
2223
* [Installing Plugins](bot/plugin-system/installing-plugins.md)
2324
* [Create Plugins](bot/plugin-system/create-plugins.md)
@@ -30,7 +31,10 @@
3031

3132
## 🌐 Webinterface
3233

33-
* [Self hosting](webinterface/self-hosting.md)
34+
* [What is the Webinterface?](webinterface/what-is-the-webinterface.md)
35+
* [Self hosting](webinterface/self-hosting/README.md)
36+
* [Self host with Pterodactyl](webinterface/self-hosting/self-host-with-pterodactyl.md)
37+
* [Self host with Docker](webinterface/self-hosting/self-host-with-docker.md)
3438

3539
## ⁉️ Troubleshooting
3640

‎bot/self-hosting/self-host-with-docker.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
description: A Guide about how to self host Ree6 with Docker!
3+
---
4+
5+
# Self host with Docker
6+
7+
## Docker Compose
8+
9+
```yaml
10+
services:
11+
ree6:
12+
image: ree6/bot:3.1.12
13+
volumes:
14+
- /PATH/bot/storage:/storage
15+
- /PATH/bot/languages:/languages
16+
- /PATH/bot/config.yml:/config.yml
17+
depends_on:
18+
- db
19+
db:
20+
image: mariadb:latest
21+
environment:
22+
MYSQL_ROOT_PASSWORD: password
23+
MYSQL_DATABASE: ree6
24+
MYSQL_USER: ree6
25+
MYSQL_PASSWORD: ree6
26+
volumes:
27+
- /PATH/db:/var/lib/mysql
28+
29+
```

‎webinterface/self-hosting.md ‎webinterface/self-hosting/README.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,10 @@ description: A Guide about how to self host Ree6's Webinterface!
44

55
# Self hosting
66

7-
## Notice
8-
9-
There will be significant rewrites for this part of the Wiki containing more information for everything related to hosting the Interface with Docker/Pterodactyl.
10-
117
## Requirements
128

139
* Java 17
14-
* NodeJS 18
10+
* NodeJS 18 or 20
1511

1612
## Recommendation
1713

‎webinterface/self-hosting/self-host-with-docker.md

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
description: A Guide about how to self host the Webinterface with Docker!
3+
---
4+
5+
# Self host with Docker
6+
7+
## Docker Compose
8+
9+
```yaml
10+
version: "3"
11+
12+
services:
13+
frontend:
14+
name: frontend
15+
image: ree6/frontend
16+
environment:
17+
- BACKEND_URL=https://api.ree6.de # Change this to use your backend url
18+
- INVITE_URL=https://invite.ree6.de # Change this to your bot's invite link
19+
20+
- HOST=0.0.0.0 # IP address to listen to
21+
22+
- TZ=Europe/Berlin # Set your timezone
23+
- NODE_ENV=production # Internal server error messages will not send stacktrace to the browser in production
24+
25+
# Uncomment the lines below to enable Traefik
26+
# Don't forget to uncomment the bottom of the file as well
27+
# Don't forget to comment out the `ports` section
28+
# labels:
29+
# - traefik.http.routers.ree6_frontend.rule=Host(`ree6.example.com`) # Set to your domain (+subdomain)
30+
# - traefik.http.routers.ree6_frontend.entrypoints=websecure
31+
# - traefik.http.routers.ree6_frontend.tls.certresolver=lets-encrypt
32+
# - traefik.http.routers.ree6_frontend.service=ree6_frontend
33+
# - traefik.http.services.ree6_frontend.loadBalancer.server.port=3000 # Must be same as `PORT` variable
34+
# networks:
35+
# - traefik
36+
ports: # Comment this out if using traefik
37+
- 3000:3000 # Comment this out if using traefik
38+
39+
restart: unless-stopped
40+
backend:
41+
name: backend
42+
image: ree6/backend
43+
volumes:
44+
- /PATH/backend/config.yml:/config.yml
45+
depends_on:
46+
- db
47+
db:
48+
image: mariadb:latest
49+
environment:
50+
MYSQL_ROOT_PASSWORD: password
51+
MYSQL_DATABASE: ree6
52+
MYSQL_USER: ree6
53+
MYSQL_PASSWORD: ree6
54+
volumes:
55+
- /PATH/db:/var/lib/mysql
56+
57+
# Uncomment this to use everything in one stack.
58+
# ree6:
59+
# image: ree6/bot:3.1.12
60+
# volumes:
61+
# - /PATH/bot/storage:/storage
62+
# - /PATH/bot/languages:/languages
63+
# - /PATH/bot/config.yml:/config.yml
64+
# depends_on:
65+
# - db
66+
67+
# Uncomment this for Traefik
68+
# networks:
69+
# traefik:
70+
# external: true
71+
```

‎webinterface/self-hosting/self-host-with-pterodactyl.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
description: A Guide about how to self host the Webinterface with Pterodactyl!
3+
---
4+
5+
# Self host with Pterodactyl
6+
7+
## Egg
8+
9+
The eggs for the Frontend and Backend should be in the GitHub Repository [here](https://github.com/Ree6-Applications/Webinterface/tree/master/Eggs). 
10+
11+
## Settings
12+
13+
All the required configurations should be marked as required by Pterodactyl.

‎webinterface/what-is-the-webinterface.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
description: A page meant to inform you about our very weird system!
3+
---
4+
5+
# What is the Webinterface?
6+
7+
The Webinterface is split up into two parts a Frontend and Backend.
8+
9+
## Backend
10+
11+
It handles the logic related to Database communications and Session management.\
12+
Ours is developed in Java Springboot.
13+
14+
## Frontend
15+
16+
This is the actual website you will visit and use since it will give you a visual overview of managing all the settings.\
17+
It's made in Svelte.

0 commit comments

Comments
 (0)