Update README
This commit is contained in:
parent
6141be7f89
commit
4b8ec2b4c5
52
README.md
52
README.md
|
@ -43,42 +43,52 @@ Open an issue to have your instance listed here!
|
||||||
| [i.bcow.xyz](https://i.bcow.xyz/) | 🇨🇦 CA | |
|
| [i.bcow.xyz](https://i.bcow.xyz/) | 🇨🇦 CA | |
|
||||||
| [l4d4owboqr6xcmd6lf64gbegel62kbudu3x3jnldz2mx6mhn3bsv3zyd.onion](http://l4d4owboqr6xcmd6lf64gbegel62kbudu3x3jnldz2mx6mhn3bsv3zyd.onion/) | | |
|
| [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
|
* 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
|
go build
|
||||||
```
|
```
|
||||||
|
|
||||||
### Docker
|
Edit the config file using your preferred editor.
|
||||||
```
|
```
|
||||||
sudo docker build -t rimgo:latest .
|
nvim config.yml
|
||||||
```
|
```
|
||||||
|
|
||||||
## Running
|
You can now run rimgo.
|
||||||
|
|
||||||
### Locally
|
|
||||||
|
|
||||||
```
|
```
|
||||||
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
|
## Configuration
|
||||||
|
|
||||||
|
|
|
@ -1,4 +0,0 @@
|
||||||
RIMGU_PORT: 3000
|
|
||||||
RIMGU_HOST: localhost
|
|
||||||
RIMGU_ADDRESS: 0.0.0.0
|
|
||||||
RIMGU_IMGUR_CLIENT_ID: 546c25a59c58ad7
|
|
|
@ -0,0 +1,4 @@
|
||||||
|
RIMGU_PORT: 3000
|
||||||
|
RIMGU_HOST: localhost
|
||||||
|
RIMGU_ADDRESS: 0.0.0.0
|
||||||
|
RIMGU_IMGUR_CLIENT_ID: 546c25a59c58ad7
|
Loading…
Reference in New Issue