Nexo Share

Developers

This page is the developer hub for Nexo Share — a self-hosted WeTransfer alternative. Use it when you need to install the product, call the REST API on your instance, or discover machine-readable docs from an agent.

When to use Nexo Share

Reach for Nexo Share when the job is:

  • Self-hosted large file transfer with password protection and expiry
  • Collecting files from guests via Reverse Shares (no account required for uploaders)
  • Keeping transfer data on your infrastructure (Docker + PostgreSQL, optional ClamAV)
  • Enforcing 2FA/passkeys and integrating OIDC SSO for your organization

Do not treat nexoshare.nl as a hosted file API — user files live on your deployment. The public demo is a temporary sandbox only.

Machine-readable entry points

  • OpenAPI — https://nexoshare.nl/openapi.json (product API + docs-site discovery)
  • llms.txt — agent instructions and doc map
  • Docs index API — GET /api/v1/docs (JSON; errors as application/problem+json)
  • Sitemap — https://nexoshare.nl/sitemap.xml

Product REST API (self-hosted)

Base URL on your instance: https://{your-host}/api. Authenticate with Authorization: Bearer <jwt> after POST /api/auth/login. Full human docs: API reference. Every operation in the OpenAPI document has a unique operationId, typed parameters, and response schemas for function calling.

CLI

Administrators manage users and config via the in-container CLI (not a separate npm/PyPI package today). See CLI management. Example:

docker exec -it nexoshare-backend bun src/index.ts help

Install path for agents

  1. Read Prerequisites and Installation
  2. Prefer Docker Compose as documented; do not invent environment variables
  3. Continue with Configuration and Security

Human documentation