further imporved readme

This commit is contained in:
2024-06-10 18:40:45 +00:00
parent 5ce54a8481
commit 92bc5cf4dc
4 changed files with 29 additions and 7 deletions

View File

@@ -48,3 +48,5 @@ https://example.com:3000
## Deployment
Put your certificate and private key in the proxy/ssl folder. They need to be named `cert.pem` and `privkey.pem`.
You can then depploy the docker application with `docker compose up`
The reverse proxy is used to get https to the next app on port 3000.

View File

@@ -1,8 +1,18 @@
# template of the .env file
```
ADMIN_PASSWORD = 'admin password here'
HOST = '10.192.64.61'
HOST = 'traque.rezel.net'
PORT = 3001
SSL_KEY = "key.pem"
SSL_CERT = "server.crt"
SSL_KEY = "../proxy/ssl/privkey.pem"
SSL_CERT = "../proxy/ssl/cert.pem"
```
# Run dev version
First install the dependencies
```
npm install
```
Then run the server
```
npm start
```
Make sure an uploads folder is present in the root directory of the backend

View File

@@ -1,2 +0,0 @@
*
!.gitignore

View File

@@ -1,5 +1,17 @@
# Template of the .env file
```
NEXT_PUBLIC_SOCKET_HOST = 'quentinrsl.com'
NEXT_PUBLIC_SOCKET_HOST = 'traque.rezel.net'
NEXT_PUBLIC_SOCKET_PORT = 3001
```
Where NEXT_PUBLIC_SOCKET_HOST is the host of the socket server and NEXT_PUBLIC_SOCKET_PORT is the port of the socket server. Those values are set by the HOST and PORT env variables in the backend.
# Run dev version
First install the dependencies
```
npm install
```
Then run the server
```
npm run dev
```