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.
261 Commits 2 Branches 0 Tags 3.4 MiB
TypeScript 98.9%
JavaScript 0.5%
Dockerfile 0.4%
CSS 0.1%
Go to file
Sylver 5d0329a99d fix: increase error message size 2024-05-18 21:59:37 +08:00
.github/workflows build: use buildx 2022-07-19 02:14:18 +08:00
.vscode feat: s3 external storage, biome linting 2024-05-16 20:55:30 +08:00
example chore: update example 2024-05-17 00:06:44 +08:00
packages fix: increase error message size 2024-05-18 21:59:37 +08:00
.dockerignore build: smaller docker images 2022-07-05 18:39:30 +08:00
.gitignore feat: s3 external storage, biome linting 2024-05-16 20:55:30 +08:00
.pnpmfile.cjs feat: replace nextjs with preact+vite+vike 2024-01-28 06:48:06 +08:00
.syncpackrc update deps, move to atlas configs 2024-01-07 12:19:16 +08:00
Dockerfile chore: unused patches dir 2024-02-12 19:19:35 +08:00
LICENSE chore: switch to agpl 2024-02-12 04:41:13 +08:00
README.md chore: update example 2024-05-17 00:06:44 +08:00
biome.json feat: s3 external storage, biome linting 2024-05-16 20:55:30 +08:00
compose.yml chore: update example 2024-05-17 00:06:44 +08:00
package.json feat: s3 external storage, biome linting 2024-05-16 20:55:30 +08:00
pnpm-lock.yaml feat: s3 external storage, biome linting 2024-05-16 20:55:30 +08:00
pnpm-workspace.yaml feat: mikroorm, convert to monorepo 2021-10-02 22:17:05 +00:00
turbo.json chore: eslint with strict type imports 2024-02-12 19:04:42 +08:00
wrapper.sh fix: forgot that was necessary 2024-02-11 12:59:27 +08:00

README.md


🔵 discord 🟣 hosted instance

micro

A vanity 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
  • Decay files to S3 to save space

screenshots

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

installation

See the example directory for how to setup micro.

development

You can pull the repo and then pnpm install, after that everything should be good to go. You can start the packages/api/packages/web with pnpm watch.

web package notes

[!IMPORTANT] tl;dr, web is quirky and some packages that depend on react may break. if they do, try adding them to noExternal in vite.config.ts and they'll probably work.

The web package is a little weird. It uses vike in place of what might normally be nextjs, preact in place of react and vite to build it all. Unlike nextjs, we have much more control over rendering, SSR, routing, etc. It's much faster, and much more fun. Of course, nothing is free - some hacky workarounds are required to get it working.

Preact is smaller, faster, and more fun than react. It's a drop-in replacement, but actually dropping it in is the hard part. The main problem is that in SSR mode, vite does not bundle dependencies, which means aliasing react to preact does not work because it's not transforming the packages to replace the react imports. You can force it to bundle dependencies, but then it chokes on some node dependencies like fastify. The only way I've found to get around this is to:

  • Alias react to preact in node_modules using .pnpmfile.cjs
  • Add some packages that still complain to noExternal in vite.config.ts, which forces them to be bundled and appears to resolve any remaining issues.

tsup is used as a final build step to bundle everything together. Vite breaks doing this, but not doing it results in much larger docker images.

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

sylo.digital