micro
An invite-only file sharing service with support for ShareX. You can see a preview at https://micro.sylo.digital
features
- ShareX Support
- Video and image thumbnails
- Config generation
- Encrypted pastes
- File name preservation
- Video, image, text and markdown previews
- Syntax highlighting for supported files
- Deletion URLs
- Dashboard
- Permissions
- Invite links
- URL Shortening
- Mobile support
- EXIF metadata removal
- Conversions (GIF>WebM, WebP>PNG, etc.)
- Purging of old and/or large files (
config.purge
).
screenshots
installation
If you need help, join the discord server. This guide assumes you are on linux with a basic understanding of linux and docker.
To migrate from micro 0.0.x to 1.0.0, see MIGRATING.md.
- Install
git
,docker
anddocker-compose
- Download the files in this repository,
git clone https://github.com/sylv/micro.git
- Copy the example configs to the current directory,
cp ./micro/example/* ./
- Fill out
.microrc.yaml
,Caddyfile
anddocker-compose.yml
. It is extremely important you read through each of the 3 files and make sure you understand what they do. Specifically,.microrc.yaml
contains a secret that handles authentication, if it is not a secure random string everyone can sign in as anyone they want without a password. - Run
docker-compose up -d
to start the database and micro. - Get the startup invite by doing
docker-compose logs micro
and copying the invite URL that should be somewhere towards the end of the log. Go to that URL to create the first account.
Setup is now complete and your instance should be working.
updating
You should take a full database backup before updating. Pending database migrations will be applied automatically on startup.
docker-compose pull micro
docker-compose up -d micro
todo
- Ratelimiting
- Admin UI
- Deletion URLs for pastes/links
- Password recovery via emails
- SQLite support
- Private email aliases like firefox relay (might be difficult/expensive)