rimgo/README.md

4.7 KiB

rimgo

An alternative frontend for Imgur. Based on rimgu and rewritten in Go.

License: AGPLv3

It's read-only and works without JavaScript. Images and albums can be viewed without wasting resources from downloading and running tracking scripts. No sign-up nags.

Features

  • URL-compatible with i.imgur.com - just replace the domain in the URL
  • Images and videos (gifv, mp4)
  • Galleries with comments
  • Albums
  • User page
  • Tag page

This is currently very early stage software. Some things left to implement (contributions welcome!):

  • Streaming (currently media is downloaded in full in rimgu before it's returned)
  • Localization/internationalization
  • Pretty CSS styling (responsive?)
  • Support for other popular image sites
  • Filtering and exploration on user/tags pages
  • Responsive scaling of videos on user/tags pages
  • Logo

Things that are considered out of scope:

  • Uploading, commenting, voting, etc - rimgo is read-only.
  • Authentication, serving HTTPS, rate limiting, etc - Use a reverse proxy or load balancer like Caddy, Traefik, or NGINX.
  • Anything requiring JavaScript or the client directly interacting with upstream servers.

Instances

Open an issue to have your instance listed here!

Website Country Cloudflare
i.bcow.xyz (official) 🇨🇦 CA
rimgo.bcow.xyz (official) 🌐 Global
rimgo.pussthecat.org 🇩🇪 DE
img.riverside.rocks 🇺🇸 US
rimgo.totaldarkness.net 🇨🇦 CA
rimgo.bus-hit.me 🇨🇦 CA
rimgo.esmailelbob.xyz 🇨🇦 CA
l4d4owboqr6xcmd6lf64gbegel62kbudu3x3jnldz2mx6mhn3bsv3zyd.onion
jx3dpcwedpzu2mh54obk5gvl64i2ln7pt5mrzd75s4jnndkqwzaim7ad.onion 🇺🇸 US

rimgo.bcow.xyz is running on AWS Lambda@Edge for a global serverless deployment, there may be issues and CloudFront collects some anonymous usage statistics.

Install

rimgo can run on any platform Go compiles on.

Docker

Install Docker and docker-compose, then clone this repository.

git clone https://codeberg.org/video-prize-ranch/rimgo
cd rimgo

Edit the docker-compose.yml file using your favorite text editor.

nvim docker-compose.yml

Optional: Never type sudo in for docker commands again! Add a docker group and add your user to it.

sudo groupadd docker
sudo usermod -aG docker $USER

You may need to log out and then log back if you are on a linux server or if you are on desktop you need to restart your desktop session

You can now run rimgo.

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

Edit the config file using your preferred editor.

nvim config.yml

You can now run rimgo.

./rimgo

Configuration

rimgo can be configured using environment variables or a config file.

Environment variables

Name Default
RIMGU_PORT 3000
RIMGU_HOST localhost
RIMGU_ADDRESS 0.0.0.0
RIMGU_IMGUR_CLIENT_ID 546c25a59c58ad7

Contributing

PRs are welcome! You can also send patches to cb.8a3w5@simplelogin.co but pull requests are preferred.

This software is released under the AGPL 3.0 license. In short, this means that if you make any modifications to the code and then publish the result (e.g. by hosting the result on a web server), you must publicly distribute your changes and declare that they also use AGPL 3.0.