A minimalist, easy-to-host service for sharing images and other files.
Deploy this app to Linode with a free $100 credit!
PicoShare is a minimalist service that allows you to share files easily.
There are a million services for sharing files, but none of them are quite like PicoShare. Here are PicoShare's advantages:
PS_SHARED_SECRET=somesecretpass PORT=4001 \
go run cmd/picoshare/main.go
To run PicoShare within a Docker container, mount a volume from your local system to store the PicoShare sqlite database.
docker run \
--env "PORT=4001" \
--env "PS_SHARED_SECRET=somesecretpass" \
--publish 4001:4001/tcp \
--volume "${PWD}/data:/data" \
--name picoshare \
mtlynch/picoshare
If you specify settings for a Litestream-compatible cloud storage location, PicoShare will automatically replicate your data.
You can kill the container and start it later, and PicoShare will restore your data from the cloud storage location and continue as if there was no interruption.
PORT=4001
PS_SHARED_SECRET="somesecretpass"
LITESTREAM_BUCKET=YOUR-LITESTREAM-BUCKET
LITESTREAM_ENDPOINT=YOUR-LITESTREAM-ENDPOINT
LITESTREAM_ACCESS_KEY_ID=YOUR-ACCESS-ID
LITESTREAM_SECRET_ACCESS_KEY=YOUR-SECRET-ACCESS-KEY
docker run \
--publish "${PORT}:${PORT}/tcp" \
--env "PORT=${PORT}" \
--env "PS_SHARED_SECRET=${PS_SHARED_SECRET}" \
--env "LITESTREAM_ACCESS_KEY_ID=${LITESTREAM_ACCESS_KEY_ID}" \
--env "LITESTREAM_SECRET_ACCESS_KEY=${LITESTREAM_SECRET_ACCESS_KEY}" \
--env "LITESTREAM_BUCKET=${LITESTREAM_BUCKET}" \
--env "LITESTREAM_ENDPOINT=${LITESTREAM_ENDPOINT}" \
--name picoshare \
mtlynch/picoshare
Notes:
To run PicoShare under docker-compose, copy the following to a file called docker-compose.yml
and then run docker-compose up
.
version: "3.2"
services:
picoshare:
image: mtlynch/picoshare
environment:
- PORT=4001
- PS_SHARED_SECRET=dummypass # Change to any password
ports:
- 4001:4001
command: -db /data/store.db
volumes:
- ./data:/data
Flag | Meaning | Default Value |
---|---|---|
-db |
Path to SQLite database | "data/store.db" |
-vacuum |
Vacuum database periodically to reclaim disk space (increases RAM usage) | false |
You can adjust behavior of the Docker container by passing these parameters with docker run -e
:
Environment Variable | Meaning |
---|---|
PORT |
TCP port on which to listen for HTTP connections (defaults to 4001). |
LITESTREAM_BUCKET |
Litestream-compatible cloud storage bucket where Litestream should replicate data. |
LITESTREAM_ENDPOINT |
Litestream-compatible cloud storage endpoint where Litestream should replicate data. |
LITESTREAM_ACCESS_KEY_ID |
Litestream-compatible cloud storage access key ID to the bucket where you want to replicate data. |
LITESTREAM_SECRET_ACCESS_KEY |
Litestream-compatible cloud storage secret access key to the bucket where you want to replicate data. |
If you rebuild the Docker image from source, you can adjust the build behavior with docker build --build-arg
:
Build Arg | Meaning | Default Value |
---|---|---|
litestream_version |
Version of Litestream to use for data replication | 0.3.9 |
PicoShare is easy to deploy to cloud hosting platforms:
Please login to review this project.
No reviews for this project yet.
Lightweight server to share files, which expire after a set…
Open Source and self-hosted files sharing application based…
Let's Upload that FIle, client-side encrypted.
Comments (0)
Please login to join the discussion on this project.