Skip to content

Commit 5c119c4

Browse files
Bot Updating Templated Files
1 parent 387ac61 commit 5c119c4

2 files changed

Lines changed: 33 additions & 28 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ If you are proposing additional packages to be added, ensure that you added the
9696

9797
### Testing your changes
9898

99-
```
99+
```bash
100100
git clone https://github.com/linuxserver/docker-projectsend.git
101101
cd docker-projectsend
102102
docker build \
@@ -106,13 +106,14 @@ docker build \
106106
```
107107

108108
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
109-
```
109+
110+
```bash
110111
docker run --rm --privileged multiarch/qemu-user-static:register --reset
111112
```
112113

113114
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
114115

115-
## Update the chagelog
116+
## Update the changelog
116117

117118
If you are modifying the Dockerfiles or any of the startup scripts in [root](https://github.com/linuxserver/docker-projectsend/tree/master/root), add an entry to the changelog
118119

README.md

Lines changed: 29 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- DO NOT EDIT THIS FILE MANUALLY -->
2-
<!-- Please read the CONTRIBUTING.md -->
2+
<!-- Please read the https://github.com/linuxserver/docker-projectsend/blob/master/.github/CONTRIBUTING.md -->
33

44
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
55

@@ -12,13 +12,14 @@
1212

1313
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring:
1414

15-
* regular and timely application updates
16-
* easy user mappings (PGID, PUID)
17-
* custom base image with s6 overlay
18-
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
19-
* regular security updates
15+
* regular and timely application updates
16+
* easy user mappings (PGID, PUID)
17+
* custom base image with s6 overlay
18+
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
19+
* regular security updates
2020

2121
Find us at:
22+
2223
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
2324
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
2425
* [Discourse](https://discourse.linuxserver.io) - post on our community forum.
@@ -56,6 +57,13 @@ The architectures supported by this image are:
5657
| arm64 | arm64v8-latest |
5758
| armhf | arm32v7-latest |
5859

60+
## Application Setup
61+
62+
*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`
63+
64+
Requires a user and database in either mysql or mariadb.
65+
66+
More info at [ProjectSend](http://www.projectsend.org).
5967

6068
## Usage
6169

@@ -87,7 +95,7 @@ services:
8795
8896
### docker cli
8997
90-
```
98+
```bash
9199
docker run -d \
92100
--name=projectsend \
93101
-e PUID=1000 \
@@ -101,7 +109,6 @@ docker run -d \
101109
ghcr.io/linuxserver/projectsend
102110
```
103111

104-
105112
## Parameters
106113

107114
Container 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.
@@ -122,7 +129,7 @@ You can set any environment variable from a file by using a special prepend `FIL
122129

123130
As an example:
124131

125-
```
132+
```bash
126133
-e FILE__PASSWORD=/run/secrets/mysecretpassword
127134
```
128135

@@ -141,28 +148,17 @@ Ensure any volume directories on the host are owned by the same user you specify
141148

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

144-
```
151+
```bash
145152
$ id username
146153
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
147154
```
148155

149-
150-
&nbsp;
151-
## Application Setup
152-
153-
*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`
154-
155-
Requires a user and database in either mysql or mariadb.
156-
157-
More info at [ProjectSend](http://www.projectsend.org).
158-
159-
160156
## Docker Mods
157+
161158
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=projectsend&query=%24.mods%5B%27projectsend%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=projectsend "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
162159

163160
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) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
164161

165-
166162
## Support Info
167163

168164
* Shell access whilst the container is running: `docker exec -it projectsend /bin/bash`
@@ -179,38 +175,45 @@ Most of our images are static, versioned, and require an image update and contai
179175
Below are the instructions for updating containers:
180176

181177
### Via Docker Compose
178+
182179
* Update all images: `docker-compose pull`
183180
* or update a single image: `docker-compose pull projectsend`
184181
* Let compose update all containers as necessary: `docker-compose up -d`
185182
* or update a single container: `docker-compose up -d projectsend`
186183
* You can also remove the old dangling images: `docker image prune`
187184

188185
### Via Docker Run
186+
189187
* Update the image: `docker pull ghcr.io/linuxserver/projectsend`
190188
* Stop the running container: `docker stop projectsend`
191189
* Delete the container: `docker rm projectsend`
192190
* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
193191
* You can also remove the old dangling images: `docker image prune`
194192

195193
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
194+
196195
* Pull the latest image at its tag and replace it with the same env variables in one run:
197-
```
196+
197+
```bash
198198
docker run --rm \
199199
-v /var/run/docker.sock:/var/run/docker.sock \
200200
containrrr/watchtower \
201201
--run-once projectsend
202202
```
203+
203204
* You can also remove the old dangling images: `docker image prune`
204205

205206
**Note:** We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using [Docker Compose](https://docs.linuxserver.io/general/docker-compose).
206207

207208
### Image Update Notifications - Diun (Docker Image Update Notifier)
209+
208210
* We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
209211

210212
## Building locally
211213

212214
If you want to make local modifications to these images for development purposes or just to customize the logic:
213-
```
215+
216+
```bash
214217
git clone https://github.com/linuxserver/docker-projectsend.git
215218
cd docker-projectsend
216219
docker build \
@@ -220,7 +223,8 @@ docker build \
220223
```
221224

222225
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
223-
```
226+
227+
```bash
224228
docker run --rm --privileged multiarch/qemu-user-static:register --reset
225229
```
226230

0 commit comments

Comments
 (0)