Infrastructure/safetwitch
0
Fork 0
mirror of https://codeberg.org/SafeTwitch/safetwitch.git synced 2025-01-03 03:10:04 -05:00
Code Issues Activity

Update 'README.md'

Browse source
This commit is contained in:
dragongoose 2023-07-16 23:23:30 +00:00
parent d49affdd0e
commit af00bd5d95
1 changed files with 1 additions and 123 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

124
README.md
View file

@ -60,129 +60,7 @@ Instead, please donate your money to one of these charities which mean a lot to
# Getting Started
Would you like to host an instance? This section is for you.
## Docker
Using docker is the prefered way to host SafeTwitch
It can be easily setup in a few commands
### From codeberg's registry
First, clone the repository and cd into it
`git clone codeberg.org/dragongoose/safetwitch`
`cd safetwitch`
Now, change the environment variables in the docker-compose.yml
to fit your needs. An example is shown below
```yml
version: "3.9"
services:
frontend:
image: codeberg.org/dragongoose/safetwitch
ports:
- "8080:80"
environment:
- SAFETWITCH_BACKEND_DOMAIN=localhost:7000
- SAFETWITCH_INSTANCE_DOMAIN=localhost:80
- SAFETWITCH_HTTPS=false
backend:
image: codeberg.org/dragongoose/safetwitch-backend
ports:
- "7000:7000"
environment:
- PORT=7000
- URL=http://localhost:7000
```
Finally, run docker-compose
`docker-compose up`
### From source
First, clone the repository and cd into it
`git clone https://codeberg.org/dragongoose/safetwitch`
`cd safetwitch`
cd into the docker directory
`cd docker`
Modify the environment variables in the docker-compose.yml file to fit your needs
Now, run docker-compose in the docker folder
`docker-compose up`
## Without docker
This method isn't prefered, but there's nothing wrong with doing it.
### Setting up the frontend
First, let's clone the repository and cd into it
`git clone https://codeberg.org/dragongoose/safetwitch`
`cd safetwitch`
Now, we have to build the frontend.
First, set the environment variables in the .env file to your needs. Here's an example:
**This step is important, once the frontend is built, the env variables become hard coded**
```env
VITE_BACKEND_DOMAIN=localhost:7000
VITE_INSTANCE_DOMAIN=localhost:5173
VITE_HTTPS=false
```
Perfect, now we can build the frontend by running this command
`npm run build`
Once this finished, a new `dist` folder will appear. Put the contents of this folder into wherever your http server is. For the tutorial's sake, we'll use nginx.
`cd dist`
`mv ./* /var/www/html`
To have nginx allow for the SPA aspect of vue to work, we need to set the config option try_files.
```conf
events {}
http {
include mime.types;
server {
listen 80;
access_log off;
error_log off;
location / {
root /app;
index index.html;
try_files $uri $uri/ /index.html;
}
}
}
```
With that all set up, you can turn nginx on and start using SafeTwitch! (unless you need to setup the backend...)
### Setting up the backend
Setting up the backend is easier, first, let's clone it
`git clone https://codeberg.org/dragongoose/safetwitch-backend`
`cd safetwitch-backend`
Be sure to set the environment variables in the .env file. Here's an example:
```env
URL=http://localhost:7000
PORT:7000
```
Now we have to install dependencies
`npm i --production`
Finally, we can start the server
`node index`
All documentation can be found on the [wiki](https://codeberg.org/dragongoose/safetwitch/wiki)
## Translate
<a href="https://translate.codeberg.org/engage/safetwitch/">