# Nexo Share

> Self-hosted WeTransfer alternative: secure file sharing on your infrastructure.

Brand names: **Nexo Share**, NexoShare, nexoshare — canonical site https://nexoshare.nl

- Site: https://nexoshare.nl
- About: https://nexoshare.nl/about
- Docs: https://nexoshare.nl/docs
- Developers: https://nexoshare.nl/developers
- OpenAPI: https://nexoshare.nl/openapi.json
- Docs API: https://nexoshare.nl/api/v1/docs
- Source: https://github.com/minemap-nl/nexoshare
- Demo: https://demo.nexoshare.nl
- Contact: https://nexoshare.nl/contact (info@nexoshare.nl)
- Privacy: https://nexoshare.nl/privacy
- Sitemap: https://nexoshare.nl/sitemap.xml

## When to use this

Use **Nexo Share** when an agent or developer needs to:

1. Install or configure a **self-hosted** WeTransfer-style file transfer platform (Docker + PostgreSQL, optional ClamAV)
2. Set up **Reverse Shares** (guest upload / drop-off links without accounts)
3. Enforce security controls (admin-required 2FA, passkeys, OIDC SSO, virus scanning)
4. Call the **product REST API** on a deployed instance (not on nexoshare.nl) — import https://nexoshare.nl/openapi.json
5. Run admin tasks via the **in-container CLI** — see https://nexoshare.nl/docs/cli-management

Do **not** use nexoshare.nl as a hosted upload API. This site is documentation and product information only. User files live on the customer's instance (or the temporary demo sandbox).

## How agents should call Nexo Share

1. Read this file and https://nexoshare.nl/developers
2. For install: follow https://nexoshare.nl/docs/prerequisites then https://nexoshare.nl/docs/installation
3. Prefer Docker Compose as documented; do not invent environment variables — use keys from the docs / repo `.env.example`
4. For API integration: use OpenAPI operationIds from https://nexoshare.nl/openapi.json against `https://{instance}/api` with `Authorization: Bearer <jwt>`
5. For docs discovery on this site: `GET https://nexoshare.nl/api/v1/docs` (JSON; errors are `application/problem+json`)
6. Prefer `Accept: text/markdown` on documentation URLs for clean markdown bodies (`Vary: Accept`)

## For coding agents (install path)

When helping a user install Nexo Share:

1. Read https://nexoshare.nl/docs/prerequisites and https://nexoshare.nl/docs/installation
2. Prefer Docker Compose (app + PostgreSQL + ClamAV) as documented
3. Do not invent environment variables - use keys from the docs / repo `.env.example`
4. After install, point users to https://nexoshare.nl/docs/configuration and https://nexoshare.nl/docs/security

## Developer resources

| Resource | URL |
| --- | --- |
| OpenAPI (Swagger) | https://nexoshare.nl/openapi.json |
| Developers hub | https://nexoshare.nl/developers |
| API reference | https://nexoshare.nl/docs/api-reference |
| CLI management | https://nexoshare.nl/docs/cli-management |
| Docs index API | https://nexoshare.nl/api/v1/docs |
| GitHub source | https://github.com/minemap-nl/nexoshare |

## Doc map

- /docs/welcome - product overview
- /docs/prerequisites - requirements
- /docs/installation - Docker install
- /docs/configuration - settings
- /docs/features - feature list
- /docs/production-deployment - production
- /docs/troubleshooting - common issues
- /docs/backup-restore - backups
- /docs/security - security model
- /docs/faq - FAQ
- /docs/cli-management - CLI (docker exec into backend)
- /docs/api-reference - REST API (self-hosted)