1st draft README , tidy up dev cruft old dependencies etc

This commit is contained in:
sparklyballs 2017-04-27 16:06:02 +01:00
parent 81c45087c7
commit 9b5964e24a
2 changed files with 22 additions and 24 deletions

View File

@ -6,15 +6,10 @@ ARG BUILD_DATE
ARG VERSION
LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}"
# set default root password for database
ENV MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD:-root}
# install packages
RUN \
apk add --no-cache \
apk add --no-cache --virtual=build-dependencies \
curl \
mariadb \
mariadb-client \
tar && \
apk add --no-cache \
--repository http://nl.alpinelinux.org/alpine/edge/community \
@ -33,6 +28,8 @@ RUN \
/usr/share/webapps/projectsend --strip-components=1 && \
# cleanup
apk del --purge \
build-dependencies && \
rm -rf \
/tmp/*
@ -41,4 +38,4 @@ COPY root/ /
# ports and volumes
EXPOSE 80
VOLUME /config
VOLUME /config /data

View File

@ -2,8 +2,8 @@
[forumurl]: https://forum.linuxserver.io
[ircurl]: https://www.linuxserver.io/irc/
[podcasturl]: https://www.linuxserver.io/podcast/
[appurl]: www.example.com
[hub]: https://hub.docker.com/r/example/example/
[appurl]: http://www.projectsend.org
[hub]: https://hub.docker.com/r/linuxserver/projectsend/
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
@ -12,23 +12,23 @@ The [LinuxServer.io][linuxserverurl] team brings you another container release f
* [IRC][ircurl] on freenode at `#linuxserver.io`
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
# <image-name>
# linuxserver/projectsend
[![](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)](http://microbadger.com/images/linuxserver/projectsend "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/projectsend.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/projectsend.svg)][hub][![Build Status](http://jenkins.linuxserver.io:8080/buildStatus/icon?job=Dockers/LinuxServer.io/linuxserver-projectsend)](http://jenkins.linuxserver.io:8080/job/Dockers/job/LinuxServer.io/job/linuxserver-projectsend/)
Provide a short, concise description of the application. No more than two SHORT paragraphs. Link to sources where possible and include an image illustrating your point if necessary. Point users to the original applications website, as that's the best place to get support - not here.
[ProjectSend][appurl] 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!
Our Plex container has immaculate docs so follow that if in doubt for layout.
`IMPORTANT, replace all instances of <image-name> with the correct dockerhub repo (ie linuxserver/plex) and <container-name> information (ie, plex)`
[![projectsend](http://www.projectsend.org/wp-content/themes/projectsend/img/screenshots.png)][appurl]
## Usage
```
docker create \
--name=<container-name> \
--name=projectsend \
-v <path to data>:/config \
-v <path to data>:/data \
-e PGID=<gid> -e PUID=<uid> \
-p 1234:1234 \
<image-name>
-p 80:80 \
linuxserver/projectsend
```
## Parameters
@ -40,12 +40,13 @@ http://192.168.x.x:8080 would show you what's running INSIDE the container on po
* `-p 1234` - the port(s)
* `-v /config` - explain what lives here
* `-p 80` - the port(s)
* `-v /config` - where to store projectsend config files
* `-v /data` - where to store files to share.
* `-e PGID` for GroupID - see below for explanation
* `-e PUID` for UserID - see below for explanation
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it <container-name> /bin/bash`.
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it projectsend /bin/bash`.
### User / Group Identifiers
@ -65,16 +66,16 @@ Insert a basic user guide here to get a n00b up and running with the software in
## Info
* Shell access whilst the container is running: `docker exec -it <container-name> /bin/bash`
* To monitor the logs of the container in realtime: `docker logs -f <container-name>`
* 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" }}' <container-name>`
`docker inspect -f '{{ index .Config.Labels "build_version" }}' projectsend`
* image version number
`docker inspect -f '{{ index .Config.Labels "build_version" }}' <image-name>`
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/projectsend`
## Versions