Skip to content
/ ume Public
forked from auguwu/ume

πŸ’ ζ’… β€” Easy, self-hostable, and flexible image and file host, made in Go using MongoDB GridFS.

License

Notifications You must be signed in to change notification settings

githork/ume

Β 
Β 

Repository files navigation

πŸ’– ζ’… "ume" β€’ Lint on Commit golangci Docker Pulls GitHub Sponsors

Easy, self-hostable, and flexible image and file host, made in Go using MongoDB GridFS.

What is ume?

ume (case sensitive) is a simple image host to use with ShareX or Flameshot to provide a blazing fast way to send images to your friends on Discord, Telegram, and more.

Installation

You are required a MongoDB connection (Atlas also works!) and Go 1.16 or higher.

Docker

Docker is required on your system to use the image.

# 1. Pull from Docker Hub
$ docker pull auguwu/ume:latest

# 2. Run the image!
$ docker run -d -p 3621:3621 --name ume --restart always \
  -v /path/to/.env:/app/ume/.env \
  auguwu/ume

Git repository

If you're using Windows, you need make installed in your system. You can use chocolatey to do so:

$ choco install make

# 1. Pull the repository
$ git clone https://github.com/auguwu/ume && cd ume

# 2. Pull the dependencies
$ go get

# 3. Run `make build` to build a binary in `./build/ume`
$ make build

# 4. Run the binary!
$ ./build/ume # append `.exe` if on Windows

Configuration

ume can be configured using Environment Variables. Provide a .env file in the root directory of where you cloned ume in:

# Authorization key when uploading images.
AUTH=(run `node -e 'process.stdout.write(require("crypto").randomBytes(32).toString("hex") + "\n")'` to generate one!)

# The database name when connecting to MongoDB
DB=ume

# The database connection URI, must start with `mongodb` or `mongodb+srv`.
DB_URL=mongodb://localhost:27017

License

ume is released under MIT License by Noel, read here for more information.

About

πŸ’ ζ’… β€” Easy, self-hostable, and flexible image and file host, made in Go using MongoDB GridFS.

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 61.6%
  • Shell 24.5%
  • Makefile 9.2%
  • Dockerfile 4.7%