From 4b8ec2b4c5163ff8c0dee1574dd5b3f84028cd9b Mon Sep 17 00:00:00 2001 From: video-prize-ranch Date: Mon, 17 Jan 2022 18:30:51 -0500 Subject: [PATCH] Update README --- README.md | 52 +++++++++++++++++++++++++++------------------- config.example.yml | 4 ---- config.yml | 4 ++++ 3 files changed, 35 insertions(+), 25 deletions(-) delete mode 100644 config.example.yml diff --git a/README.md b/README.md index 79e8ddd..97e74c9 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/config.example.yml b/config.example.yml deleted file mode 100644 index 6f71716..0000000 --- a/config.example.yml +++ /dev/null @@ -1,4 +0,0 @@ -RIMGU_PORT: 3000 -RIMGU_HOST: localhost -RIMGU_ADDRESS: 0.0.0.0 -RIMGU_IMGUR_CLIENT_ID: 546c25a59c58ad7 \ No newline at end of file diff --git a/config.yml b/config.yml index e69de29..6f71716 100644 --- a/config.yml +++ b/config.yml @@ -0,0 +1,4 @@ +RIMGU_PORT: 3000 +RIMGU_HOST: localhost +RIMGU_ADDRESS: 0.0.0.0 +RIMGU_IMGUR_CLIENT_ID: 546c25a59c58ad7 \ No newline at end of file