Back to all templates
PicoShare logo

PicoShare

Infrastructure64MB+ RAM

Minimalist file sharing service

filessharingminimal

Deploy PicoShare in 3 Steps

1

Connect Your VPS

Add your server credentials to Server Compass

2

Select PicoShare

Choose from our template library

3

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required
Step-by-step deployment guide

Deploy PicoShare on a VPS with Server Compass

Use the PicoShare template in Server Compass to deploy minimalist file sharing on your VPS, then verify the web UI in a browser.

About 10 minutesBrowser verified
1
Step 1

Open the server Apps tab

Select the tutorial-vps VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.

Server Compass Apps tab before creating a PicoShare app
2
Step 2

Choose an app template

Click New App and choose the template deployment path so Server Compass can load the built-in catalog.

Choosing to deploy an app from a Server Compass template
3
Step 3

Search for PicoShare

Use the template picker search to find PicoShare in the Server Compass template catalog.

Searching for PicoShare in the Server Compass template picker
4
Step 4

Select the PicoShare template

Choose the PicoShare template. Server Compass fills the file sharing service, persistent data volume, generated shared secret, and public port.

PicoShare template selected in Server Compass
5
Step 5

Review the PicoShare settings

Confirm the app name, generated shared secret, and compose service. In this run, the app was named picoshare-demo and used host port 4001.

Reviewing PicoShare project settings and generated secret
6
Step 6

Deploy PicoShare

Review the generated compose settings, confirm the PicoShare web port is available, and click Deploy.

Reviewing PicoShare environment variables and port before deployment
7
Step 7

Watch the deployment progress

Keep the deployment modal open while Server Compass uploads the compose file, pulls the PicoShare image, starts the container, and verifies the stack.

Server Compass deploying the PicoShare template on the VPS
8
Step 8

Confirm PicoShare is running

After deployment finishes, return to the Apps tab and confirm the PicoShare app is marked Running with its application URL available.

PicoShare template running in the Server Compass Apps tab
9
Step 9

Open PicoShare in the browser

Open the application URL in a browser. The PicoShare web UI confirms the file sharing service is reachable.

The deployed PicoShare web UI loaded in a browser

After PicoShare Opens

  • Store the generated shared secret securely because it controls PicoShare admin access.
  • Use a VPN, IP allowlist, firewall rule, or authenticated reverse proxy for production access.
  • Upload only files you intend to share and review generated share links before sending them.
  • Back up the PicoShare data volume before moving or replacing the VPS.
  • Rotate the shared secret if it is exposed.
  • Keep the PicoShare image updated for dependency and security fixes.

Verified Result

The PicoShare web interface loaded successfully from the deployed container.

PicoShare deployment questions

What does the PicoShare template deploy?

It deploys the PicoShare container with a persistent data volume, generated shared secret, and public web port.

Which port did the tutorial use?

The tutorial used host port 4001, which maps to the PicoShare web UI on container port 4001.

How is PicoShare admin access protected?

The template generates a shared secret and passes it to PicoShare as PS_SHARED_SECRET. Keep that value private.

Should this become a blog post?

No. The deployment guide should live on the PicoShare template detail page and be linked from the reusable template deployment docs page.

Do It Yourself

Deploy PicoShare via Command Line

Prefer the command line? Follow this step-by-step guide to deploy PicoShare manually on your VPS.

1

Connect to Your Remote Server

Begin by establishing a secure connection to your server through the terminal.

terminal
# Access your VPS
ssh root@YOUR_SERVER_IP

# With SSH key authentication
ssh -i ~/.ssh/your-private-key root@YOUR_SERVER_IP

First time? Ensure Docker is installed first: curl -fsSL https://get.docker.com | sh

2

Set Up Your App Folder

Create a dedicated folder for your application files.

terminal
# Create and navigate to project directory
mkdir -p ~/apps/picoshare
cd ~/apps/picoshare
3

Set Up Docker Compose

Create the following docker-compose.yml in your project directory:

docker-compose.yml
services:
  picoshare:
    image: mtlynch/picoshare:latest
    ports:
      - "4001:4001"
    environment:
      - PS_SHARED_SECRET=<your-shared-secret>
    volumes:
      - picoshare_data:/data
    restart: unless-stopped

volumes:
  picoshare_data:
Configuration Variables
PORTHost port(default: 4001)
SHARED_SECRETShared secret
4

Spin Up the Stack

Run Docker Compose to launch your application.

terminal
# Launch the stack
docker compose up -d

# Verify container status
docker compose ps

# Follow the logs
docker compose logs --follow
5

Open the Application Port

Configure UFW to allow traffic to your application.

terminal
# Allow the application port through firewall
sudo ufw allow 4001/tcp
sudo ufw reload

# Access your app at:
# http://your-server-ip:4001
Skip the Terminal

Make it simple with Server Compass.

Deploy PicoShare with a beautiful UI instead. No SSH, no YAML editing, no terminal commands. Just click, configure, and deploy in under 3 minutes.

  • No terminal required
  • Point-and-click setup
  • Auto SSL certificates
  • Rolling deployments
  • Health monitoring
  • Instant rollbacks
Download Server Compass$29 one-time • Lifetime license

After Deployment

After deploying PicoShare with Server Compass, complete these steps to finish setup

1

Access with shared secret

2

Upload files

3

Share links

Need help? Check out our documentation for detailed guides.

PicoShare FAQ

Common questions about self-hosting PicoShare

How do I deploy PicoShare with Server Compass?

Simply download Server Compass, connect to your VPS, and select PicoShare from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.

What are the system requirements for PicoShare?

PicoShare requires a minimum of 64MB RAM. We recommend a VPS with at least 1024MB RAM for optimal performance. Any modern Linux server with Docker support will work.

Can I migrate my existing PicoShare data?

Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard PicoShare backup and restore procedures.

How do I update PicoShare to the latest version?

Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest PicoShare image will be pulled and deployed with zero downtime.

Is PicoShare free to self-host?

PicoShare is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.

Ready to Self-Host PicoShare?

Download Server Compass and deploy PicoShare to your VPS in under 3 minutes. No Docker expertise required.

Download Server Compass