rimgo/README.md

# rimgo
An alternative frontend for Imgur. Based on [rimgu](https://codeberg.org/3np/rimgu) and rewritten in Go.

<a href="https://www.gnu.org/licenses/agpl-3.0.en.html">
  <img alt="License: AGPLv3+" src="https://shields.io/badge/License-AGPL%20v3+-blue.svg">
</a>

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.

Inspired by and (soon) integratable with:

* [searx](https://github.com/searx/searx)
* [teddit](https://codeberg.org/teddit/teddit) ([integration](https://codeberg.org/teddit/teddit/pulls/249))
* [Privacy Redirect](https://github.com/SimonBrazell/privacy-redirect) ([integration](https://github.com/SimonBrazell/privacy-redirect/pull/303))
* [nitter](https://github.com/zedeus/nitter)
* [bibliogram](https://sr.ht/~cadence/bibliogram/)


## Features

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

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

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

Things that are considered out of scope:

* Uploading/commenting/voting/etc - rimgu is read-only for now.
* Authentication, serving HTTPS, rate limiting, etc - Use a reverse proxy or load balancer like Caddy, Traefik, or NGINX.
* Anything requiring client-side JS or client-side directly interacting with upstream servers

## Instances

Open an issue to have your instance listed here!

| Website                                                                                                                                  | Country | Cloudflare |
|------------------------------------------------------------------------------------------------------------------------------------------|---------|------------|
| [i.bcow.xyz](https://i.bcow.xyz/)                                                                                                        | 🇨🇦 CA   |            |
| [l4d4owboqr6xcmd6lf64gbegel62kbudu3x3jnldz2mx6mhn3bsv3zyd.onion](http://l4d4owboqr6xcmd6lf64gbegel62kbudu3x3jnldz2mx6mhn3bsv3zyd.onion/) |         |            |

## Building

### Locally

Dependencies:

* Go v1.16 or later

```
go build
```

### Docker
```
sudo docker build -t rimgo:latest .
```

## Running

### Locally

```
go run main.go
```

### 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

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!

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 webserver), you must publicly distribute your changes and declare that they also use AGPL 3.0.