ShareX
/
micro
mirror of https://github.com/sylv/micro.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
An image host with thumbnails, a dashboard, thumbnails, 2fa, url shortening and more.
218 Commits 2 Branches 0 Tags 3.4 MiB
TypeScript 98.9%
JavaScript 0.5%
Dockerfile 0.4%
CSS 0.1%
Go to file
ryan eaee2318f9 build: use tsup instead of ncc for prod builds 2023-04-05 07:39:02 +08:00
.github/workflows build: use buildx 2022-07-19 02:14:18 +08:00
.vscode chore: convert api to esm (#30) 2022-10-07 22:35:56 +08:00
example feat: conversions 2022-07-26 08:30:22 +08:00
packages build: use tsup instead of ncc for prod builds 2023-04-05 07:39:02 +08:00
.dockerignore build: smaller docker images 2022-07-05 18:39:30 +08:00
.gitignore build: use tsup instead of ncc for prod builds 2023-04-05 07:39:02 +08:00
.prettierrc feat: use file embed for pastes 2022-06-21 07:20:53 +08:00
Dockerfile build: use tsup instead of ncc for prod builds 2023-04-05 07:39:02 +08:00
LICENSE Initial commit 2020-08-27 15:36:16 +08:00
MIGRATING.md chore: cleanup readme 2022-07-05 11:58:22 +08:00
README.md feat: mfa support (#29) 2022-10-07 19:48:07 +08:00
commitlint.config.js chore: add commitlint 2021-07-15 11:07:48 +00:00
compose.yml feat(web): use pandora for ui 2022-07-26 05:59:19 +08:00
package.json chore: update deps, minor bug fixes 2023-03-31 23:40:39 +08:00
pnpm-lock.yaml build: use tsup instead of ncc for prod builds 2023-04-05 07:39:02 +08:00
pnpm-workspace.yaml feat: mikroorm, convert to monorepo 2021-10-02 22:17:05 +00:00
turbo.json build: smaller docker images 2022-07-05 18:39:30 +08:00
wrapper.sh build: use tsup instead of ncc for prod builds 2023-04-05 07:39:02 +08:00

README.md

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).
  • 2FA support

screenshots

Sign In Page Dashboard
Upload Page Text Preview
Paste Page 2FA setup

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.

  1. Install git, docker and docker-compose
  2. Download the files in this repository, git clone https://github.com/sylv/micro.git
  3. Copy the example configs to the current directory, cp ./micro/example/* ./
  4. Fill out .microrc.yaml, Caddyfile and docker-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.
  5. Run docker-compose up -d to start the database and micro.
  6. 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.

  1. docker-compose pull micro
  2. 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)

discord

sylo.digital