Update README

This commit is contained in:
video-prize-ranch 2022-01-17 18:30:51 -05:00
parent 6141be7f89
commit 4b8ec2b4c5
No known key found for this signature in database
GPG Key ID: D8EAA4C5B12A7281
3 changed files with 35 additions and 25 deletions

View File

@ -43,42 +43,52 @@ Open an issue to have your instance listed here!
| [i.bcow.xyz](https://i.bcow.xyz/) | 🇨🇦 CA | |
| [l4d4owboqr6xcmd6lf64gbegel62kbudu3x3jnldz2mx6mhn3bsv3zyd.onion](http://l4d4owboqr6xcmd6lf64gbegel62kbudu3x3jnldz2mx6mhn3bsv3zyd.onion/) | | |
## Building
## Install
Librarian can run on any platform Go compiles on.
### Locally
### Docker
Install Docker and docker-compose, then clone this repository.
```
git clone https://codeberg.org/video-prize-ranch/rimgo
cd rimgo
```
Dependencies:
Edit the `docker-compose.yml` file using your favorite text editor.
```
nvim docker-compose.yml
```
You can now run rimgo.
```
sudo docker-compose up -d
```
### Build from source
#### Requirements
* Go v1.16 or later
Clone the repository and `cd` into it.
```
git clone https://codeberg.org/video-prize-ranch/rimgo
cd rimgo
```
Build rimgo.
```
go build
```
### Docker
Edit the config file using your preferred editor.
```
sudo docker build -t rimgo:latest .
nvim config.yml
```
## Running
### Locally
You can now run rimgo.
```
go run main.go
./rimgo
```
### Docker
Without docker-compose:
```
sudo docker run -p 8080:8080 -e -it RIMGU_ADDRESS=0.0.0.0 -e RIMGU_PORT=8080 rimgu:latest
```
With docker-compose:
```
sudo docker-compose up -d
```
## Configuration

View File

@ -1,4 +0,0 @@
RIMGU_PORT: 3000
RIMGU_HOST: localhost
RIMGU_ADDRESS: 0.0.0.0
RIMGU_IMGUR_CLIENT_ID: 546c25a59c58ad7

View File

@ -0,0 +1,4 @@
RIMGU_PORT: 3000
RIMGU_HOST: localhost
RIMGU_ADDRESS: 0.0.0.0
RIMGU_IMGUR_CLIENT_ID: 546c25a59c58ad7