https://github.com/sylv/micro
A vanity image host with url shortening, 2fa, videos, and much more.
https://github.com/sylv/micro
discord docker hacktoberfest sharex sharex-server thumbnails
Last synced: 3 months ago
JSON representation
A vanity image host with url shortening, 2fa, videos, and much more.
- Host: GitHub
- URL: https://github.com/sylv/micro
- Owner: sylv
- License: agpl-3.0
- Created: 2020-08-27T07:36:14.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-05-04T00:46:32.000Z (5 months ago)
- Last Synced: 2025-05-04T01:18:49.003Z (5 months ago)
- Topics: discord, docker, hacktoberfest, sharex, sharex-server, thumbnails
- Language: TypeScript
- Homepage: https://micro.sylo.digital
- Size: 3.27 MB
- Stars: 47
- Watchers: 3
- Forks: 5
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🔵 discord 🟣 hosted instance
# micro
A vanity file sharing service with support for ShareX. You can see a preview at https://micro.sylo.digital
- [micro](#micro)
- [features](#features)
- [screenshots](#screenshots)
- [installation](#installation)
- [development](#development)
- [todo](#todo)
- [support](#support)
## features
- [x] ShareX Support
- [x] Video and image thumbnails
- [x] Config generation
- [x] Encrypted pastes
- [x] File name preservation
- [x] Video, image, text and markdown previews
- [x] Syntax highlighting for supported files
- [x] Deletion URLs
- [x] Dashboard
- [x] Permissions
- [x] Invite links
- [x] URL Shortening
- [x] Mobile support
- [x] EXIF metadata removal
- [x] Conversions (GIF>WebM, WebP>PNG, etc.)
- [x] Purging of old and/or large files (`config.purge`).
- [x] 2FA support
- [X] Decay files to S3 to save space
## screenshots
## installation
[See the `example` directory](./example) for how to setup micro.
## development
1. Pull the repo and then `pnpm install`.
2. Run `docker compose up -d` to start postgres and minio development instances.
3. Copy `micro.example.yaml` to `micro.yaml`, change any options relevant to your environment.
5. Then, you can start the `packages/api`/`packages/web` with `pnpm watch`. Keep a look out for a `InviteService` log entry, which will direct you to an invite to then create the initial account.
## 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)
## support
