docker-documentation/images/docker-projectsend.md

6.2 KiB

linuxserver/projectsend

GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io MicroBadger Layers Docker Pulls Docker Stars Build Status

Projectsend is a self-hosted application that lets you upload files and assign them to specific clients that you create yourself. Secure, private and easy. No more depending on external services or e-mail to send those files.

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling linuxserver/projectsend should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture Tag
x86-64 amd64-latest
arm64 arm64v8-latest
armhf arm32v7-latest

Usage

Here are some example snippets to help you get started creating a container from this image.

docker

docker create \
  --name=projectsend \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -e MAX_UPLOAD=<5000> \
  -p 80:80 \
  -v <path to data>:/config \
  -v <path to data>:/data \
  --restart unless-stopped \
  linuxserver/projectsend

docker-compose

Compatible with docker-compose v2 schemas.

---
version: "2"
services:
  projectsend:
    image: linuxserver/projectsend
    container_name: projectsend
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
      - MAX_UPLOAD=<5000>
    volumes:
      - <path to data>:/config
      - <path to data>:/data
    ports:
      - 80:80
    restart: unless-stopped

Parameters

Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter Function
80 WebUI

Environment Variables (-e)

Env Function
PUID=1000 for UserID - see below for explanation
PGID=1000 for GroupID - see below for explanation
TZ=Europe/London Specify a timezone to use EG Europe/London.
MAX_UPLOAD=<5000> To set maximum upload size (in MB), default if unset is 5000.

Volume Mappings (-v)

Volume Function
/config Where to store projectsend config files.
/data Where to store files to share.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Application Setup

Requires a user and database in either mssql, mysql or mariadb.

On first run go to <your-ip>/install/make-config.php and enter your database details.

More info at ProjectSend.

Support Info

  • Shell access whilst the container is running:
    • docker exec -it projectsend /bin/bash
  • To monitor the logs of the container in realtime:
    • docker logs -f projectsend
  • Container version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' projectsend
  • Image version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/projectsend

Versions

  • 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
  • 11.02.19: - Add pipeline logic and multi arch.
  • 11.06.17: - Fetch version from github.
  • 09.12.17: - Rebase to alpine 3.7.
  • 13.06.17: - Initial Release.