Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/geraldwuhoo/omgur

Private front-end for Imgur. Mirror of https://gitlab.wuhoo.xyz/jerry/omgur.
https://github.com/geraldwuhoo/omgur

golang imgur libre privacy proxy self-hosted

Last synced: about 2 months ago
JSON representation

Private front-end for Imgur. Mirror of https://gitlab.wuhoo.xyz/jerry/omgur.

Awesome Lists containing this project

README

        

# omgur

[![pipeline status](https://gitlab.wuhoo.xyz/jerry/omgur/badges/master/pipeline.svg)](https://gitlab.wuhoo.xyz/jerry/omgur/-/commits/master)

Omgur is a free and open-source alternative Imgur front-end focused on privacy.

Inspired by the [Invidious](https://github.com/iv-org/invidious), [Nitter](https://github.com/zedeus/nitter), and [Teddit](https://github.com/teddit-net/teddit) projects.

- No JavaScript or ads
- All requests go through the backend, client never talks to Imgur
- Prevents Imgur from tracking your IP or JavaScript fingerprint
- Lightweight
- Self-hostable

## Features roadmap

- [x] Direct image loading via https://i.imgur.com/
- [x] Imgur album loading via https://imgur.com/a/
- [x] Imgur gallery loading via https://imgur.com/gallery/
- [x] Imgur post loading via https://imgur.com/
- [x] Redis caching for images
- [x] Proper embedding of videos on albums/galleries (direct loading already works)
- [ ] Mock tests of the functionality

## Far-future roadmap

- [ ] Render comments on Imgur posts
- [ ] Frontpage imgur url form
- [ ] Public API endpoints

## Installation

### Docker

Using Docker and docker-compose:

```
docker-compose build
docker-compose up
```

Omgur should now be running at http://localhost:8080.

Prebuilt images are also available at `registry.wuhoo.xyz/jerry/omgur:latest` and `registry.gitlab.com/geraldwuhoo/omgur:latest`.

### Manual

1. Install [Golang](https://golang.org/).
1. (Optional) Install [redis-server](https://redis.io/).
Caches images from imgur – highly recommended.
1. Clone and set up the repository.
```
git clone https://wuhoo.xyz/jerry/gerald/omgur
cd omgur
go mod init git.geraldwu.com/gerald/omgur
go mod tidy
go build -v -a ./cmd/omgur
export REDIS_HOST=localhost
redis-server
./omgur
```

Omgur should now be running at http://localhost:8080. It is possible to change the listening port with the `OMGUR_LISTEN_PORT` environment variable if you already have services using the default port `8080`.