Self-hosted uploads for images, files, text, and short links. Built with NestJS and PostgreSQL, with OpenAPI documentation at /docs and the schema at /docs-json.
See the September 7, 2026 migration guide for upgrading from before that day’s changes, including verification and rollback.
Use Node.js 24.19 or newer within the 24.x release line and pnpm 12.3.4. Local development defaults to Node 24 in .nvmrc. Docker uses Node 26.8.1; CI runs checks and tests on both supported runtimes.
nvm use
npm install --global pnpm@12.3.4
pnpm install --frozen-lockfile
cp .env.example .env
docker compose up -d --wait db-dev
pnpm start:devEdit .env with your API key and database password before starting. The API listens on port 3000. DB_HOST=localhost is for local development; use your database service name when running in Docker.
Send X-API-Key with each upload. Successful uploads retain their existing JSON response, including stringId, deleteKey, and deletePass.
| Content | Upload | Multipart field | Retrieve |
|---|---|---|---|
| Image | POST /i |
image |
GET /i/:id |
| File | POST /f |
file |
GET /f/:id |
| Text | POST /p |
paste |
GET /p/:id |
| Link | POST /l |
JSON { "url": "https://example.com" } |
GET /l/:id |
Image URLs redirect to /i/:id/:filename. Thumbnails are available at /i/:id/thumbnail. Existing deletion URLs are preserved; keep deletion keys private.
Use the installer to generate ShareX uploader profiles and Docker Compose configuration. The paste frontend displays text, and the VS Code extension uploads editor documents.
pnpm check
pnpm build
pnpm test --runInBand
pnpm test:cov --runInBand
pnpm test:e2epnpm check runs Oxlint, Oxfmt verification, and TypeScript. Use pnpm lint:fix for lint fixes and pnpm format to format supported files. Install the workspace's recommended VS Code extensions for the same tools on save.
pnpm test:e2e starts a disposable PostgreSQL service on localhost:5433. If a failed run leaves it running, use docker compose down db-test. CI supplies its own database and runs pnpm test:e2e:ci. It also builds the container and uploads coverage without requiring secrets.
docker build -t sharex-api:local .The runtime executes dist/main.js. Persist /app/uploads and /app/thumbnails; the installer now uses these paths too. Existing files stored inside an older container must be copied into the host-mounted upload directories before replacing it.
The application uses NestJS 12 and TypeORM 1.1 with the existing CommonJS runtime. TypeScript stays on 6.0.3 because Nest CLI and ts-jest require the compiler API that TypeScript 7 does not provide. Jest scripts enable Node VM modules to load ESM dependencies. All Nest packages use matching majors. Development mode still synchronizes the schema; production mode does not. Back up the database and uploads before an upgrade, and apply schema changes deliberately for production.
The development Compose file uses PostgreSQL 17. Do not attach an older PostgreSQL data directory to a new major version: keep your existing image version or perform a PostgreSQL migration first.
Follow the project's coding standards and Oxc configuration. Linting enforces braces, a maximum nesting depth of 3, a complexity limit of 10, and no nested ternaries. Do not add tests or code comments unless requested. CI checks every pull request; Dependabot checks dependency and action updates weekly.
MIT; see LICENSE.txt. Created by Ryan Bucshon. Thanks to Sikari for feedback.
CI publishes ghcr.io/busheezy/sharex-api:latest and sha-<commit> tags after checks pass on main. Images support Linux amd64 and arm64. Pull requests build images without publishing them. Publishing uses the repository’s GitHub token; Docker Hub credentials are not required.