docker-documentation/images/docker-projectsend.md

143 wiersze
5.2 KiB
Markdown
Czysty Zwykły widok Historia

2019-04-02 20:21:42 +00:00
# [linuxserver/projectsend](https://github.com/linuxserver/docker-projectsend)
2019-02-19 18:43:37 +00:00
2019-04-02 20:21:42 +00:00
[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn)
[![](https://images.microbadger.com/badges/version/linuxserver/projectsend.svg)](https://microbadger.com/images/linuxserver/projectsend "Get your own version badge on microbadger.com")
[![](https://images.microbadger.com/badges/image/linuxserver/projectsend.svg)](https://microbadger.com/images/linuxserver/projectsend "Get your own version badge on microbadger.com")
![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/projectsend.svg)
![Docker Stars](https://img.shields.io/docker/stars/linuxserver/projectsend.svg)
[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-projectsend/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-projectsend/job/master/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/projectsend/latest/badge.svg)](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-04-02 20:21:42 +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 |
2019-04-02 20:21:42 +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
2019-04-02 20:21:42 +00:00
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
2019-04-02 20:21:42 +00:00
```
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
```
2019-04-02 20:21:42 +00:00
2019-02-19 18:43:37 +00:00
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
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
2019-04-02 20:21:42 +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
2019-04-02 20:21:42 +00:00
### Ports (`-p`)
2019-02-19 18:43:37 +00:00
| Parameter | Function |
2019-04-02 20:21:42 +00:00
| :----: | --- |
2019-02-19 18:43:37 +00:00
| `80` | WebUI |
2019-04-02 20:21:42 +00:00
### Environment Variables (`-e`)
2019-02-19 18:43:37 +00:00
| Env | Function |
2019-04-02 20:21:42 +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. |
2019-04-02 20:21:42 +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
2019-04-02 20:21:42 +00:00
### Volume Mappings (`-v`)
2019-02-19 18:43:37 +00:00
| Volume | Function |
2019-04-02 20:21:42 +00:00
| :----: | --- |
2019-02-19 18:43:37 +00:00
| `/config` | Where to store projectsend config files. |
| `/data` | Where to store files to share. |
2019-04-02 20:21:42 +00:00
2019-02-19 18:43:37 +00:00
## User / Group Identifiers
2019-04-02 20:21:42 +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
2019-04-02 20:21:42 +00:00
```
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
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](http://www.projectsend.org).
2019-04-02 20:21:42 +00:00
2019-02-19 18:43:37 +00:00
## 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
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.