2020-06-29 07:29:55 +00:00
# linuxserver/projectsend
[](https://github.com/linuxserver/docker-projectsend) [](https://github.com/linuxserver/docker-projectsend/releases) [](https://github.com/linuxserver/docker-projectsend/packages) [](https://gitlab.com/Linuxserver.io/docker-projectsend/container_registry) [](https://microbadger.com/images/linuxserver/projectsend) [](https://hub.docker.com/r/linuxserver/projectsend) [](https://hub.docker.com/r/linuxserver/projectsend) [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-projectsend/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/projectsend/latest/index.html)
2019-02-19 18:43:37 +00:00
[Projectsend ](http://www.projectsend.org ) 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
2019-09-03 20:22:12 +00:00
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 ](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list ) and our announcement [here ](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/ ).
2019-02-19 18:43:37 +00:00
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 |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-02-19 18:43:37 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-25 00:44:03 +00:00
| armhf | arm32v7-latest |
2019-02-19 18:43:37 +00:00
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
2020-06-29 07:29:55 +00:00
```text
2019-02-19 18:43:37 +00:00
docker create \
--name=projectsend \
2019-03-05 21:21:36 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-19 18:43:37 +00:00
-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.
```yaml
---
2020-04-07 20:22:14 +00:00
version: "2.1"
2019-02-19 18:43:37 +00:00
services:
projectsend:
image: linuxserver/projectsend
container_name: projectsend
environment:
2019-03-05 21:21:36 +00:00
- PUID=1000
- PGID=1000
2019-02-19 18:43:37 +00:00
- TZ=Europe/London
- MAX_UPLOAD=< 5000 >
volumes:
- < path to data > :/config
- < path to data > :/data
ports:
- 80:80
restart: unless-stopped
```
## Parameters
2020-06-29 07:29:55 +00:00
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.
2019-02-19 18:43:37 +00:00
2020-06-29 07:29:55 +00:00
### Ports \(`-p`\)
2019-02-19 18:43:37 +00:00
| Parameter | Function |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-02-19 18:43:37 +00:00
| `80` | WebUI |
2020-06-29 07:29:55 +00:00
### Environment Variables \(`-e`\)
2019-02-19 18:43:37 +00:00
| Env | Function |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-03-05 21:21:36 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-19 18:43:37 +00:00
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
2020-06-29 07:29:55 +00:00
| `MAX_UPLOAD=<5000>` | To set maximum upload size \(in MB\), default if unset is 5000. |
2019-02-19 18:43:37 +00:00
2020-06-29 07:29:55 +00:00
### Volume Mappings \(`-v`\)
2019-02-19 18:43:37 +00:00
| Volume | Function |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-02-19 18:43:37 +00:00
| `/config` | Where to store projectsend config files. |
| `/data` | Where to store files to share. |
2020-06-29 07:29:55 +00:00
## Environment variables from files \(Docker secrets\)
2020-06-02 20:22:00 +00:00
You can set any environment variable from a file by using a special prepend `FILE__` .
As an example:
2020-06-29 07:29:55 +00:00
```text
2020-06-02 20:22:00 +00:00
-e FILE__PASSWORD=/run/secrets/mysecretpassword
```
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
## Umask for running applications
2020-06-29 07:29:55 +00:00
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here ](https://en.wikipedia.org/wiki/Umask ) before asking for support.
2020-04-28 20:21:45 +00:00
2019-02-19 18:43:37 +00:00
## User / Group Identifiers
2020-06-29 07:29:55 +00:00
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` .
2019-02-19 18:43:37 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2019-03-05 21:21:36 +00:00
In this instance `PUID=1000` and `PGID=1000` , to find yours use `id user` as below:
2019-02-19 18:43:37 +00:00
2020-06-29 07:29:55 +00:00
```text
2019-02-19 18:43:37 +00:00
$ id username
2019-03-05 21:21:36 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-19 18:43:37 +00:00
```
## Application Setup
2020-06-29 07:29:55 +00:00
_IMPORTANT_ This image no longer supports MSSQL since being migrated to PHP7, if you want MSSQL support please use the tag `linuxserver/projectsend:r1053-ls27`
2019-02-19 18:43:37 +00:00
2020-04-28 13:09:12 +00:00
Requires a user and database in either mysql or mariadb.
2019-02-19 18:43:37 +00:00
More info at [ProjectSend ](http://www.projectsend.org ).
2020-04-07 20:22:14 +00:00
## Docker Mods
2020-06-29 07:29:55 +00:00
[](https://mods.linuxserver.io/?mod=projectsend)
2020-04-07 20:22:14 +00:00
2020-06-29 07:29:55 +00:00
We publish various [Docker Mods ](https://github.com/linuxserver/docker-mods ) to enable additional functionality within the containers. The list of Mods available for this image \(if any\) can be accessed via the dynamic badge above.
2019-10-01 20:21:58 +00:00
2019-02-19 18:43:37 +00:00
## Support Info
2019-09-03 20:22:12 +00:00
* Shell access whilst the container is running:
2019-02-19 18:43:37 +00:00
* `docker exec -it projectsend /bin/bash`
2019-09-03 20:22:12 +00:00
* To monitor the logs of the container in realtime:
2019-02-19 18:43:37 +00:00
* `docker logs -f projectsend`
2019-09-03 20:22:12 +00:00
* Container version number
2019-02-19 18:43:37 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' projectsend`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/projectsend`
## Versions
2020-04-28 13:09:12 +00:00
* **31.12.19:** - Rebase to Alpine 3.11 and upgrade to PHP7.
2019-03-25 00:44:03 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-19 18:43:37 +00:00
* **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.
2020-06-29 07:29:55 +00:00
