# Self-host PicoShare

> Minimalist file sharing service for sending large files by link with an optional expiry. A generated shared secret protects the upload page.

- Page: https://levelrail.com/templates/picoshare/
- JSON: https://levelrail.com/templates/picoshare.json
- Category: Storage
- Licence: AGPL-3.0-only (Network copyleft (AGPL) license)
- Source: https://github.com/mtlynch/picoshare
- Upstream docs: https://github.com/mtlynch/picoshare#readme

## Requirements
- Memory: about 64 MiB
- amd64: unknown, arm64: unknown
- Needs configuration before start: no
- Pinned image tag: v1.5.4

## Services

| Service | Image | Tag | Ports | Volumes |
| --- | --- | --- | --- | --- |
| picoshare | mtlynch/picoshare | v1.5.4 | 4001 | data -> /data |

## Environment

| Service | Variable | Kind |
| --- | --- | --- |
| picoshare | PORT | preset |
| picoshare | PS_SHARED_SECRET | generated |

## Deploy

### CLI

```bash
levelrail-cli templates install picoshare --name my-picoshare
```

Add --domain SERVICE=HOST to serve a service on your own domain, for example --domain picoshare=app.example.com.

### API

```bash
curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  https://levelrail.example.com/api/v1/service-templates/picoshare/install \
  -d '{
    "name": "my-picoshare"
  }'
```

Create a token in the dashboard first. Name, env and domains are the request fields.

## First run
1. Sign in with the generated shared secret shown in the deployment variables, then upload a file to get a link.

## Questions

### Can I deploy PicoShare on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for PicoShare, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image mtlynch/picoshare:v1.5.4 is what you deploy there.

Self-host PicoShare, PicoShare docker compose file, deploy PicoShare on a VPS: this page lists the pinned image, ports, volumes and the commands for each.
