From 49a51dcfdf30394057f50238dfcd2cf0d18b08ac Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Tue, 20 Apr 2021 13:17:29 +0000 Subject: [PATCH] Bot Updating Documentation --- images/docker-pydio-cells.md | 30 ++++++++++++++---------------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/images/docker-pydio-cells.md b/images/docker-pydio-cells.md index 96d32f691..0427348a7 100644 --- a/images/docker-pydio-cells.md +++ b/images/docker-pydio-cells.md @@ -1,6 +1,9 @@ --- title: pydio-cells --- + + + # [linuxserver/pydio-cells](https://github.com/linuxserver/docker-pydio-cells) [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-pydio-cells.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-pydio-cells) @@ -17,7 +20,7 @@ title: pydio-cells ## 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](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/). +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/). Simply pulling `ghcr.io/linuxserver/pydio-cells` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. @@ -27,6 +30,11 @@ The architectures supported by this image are: | :----: | --- | | x86-64 | amd64-latest | +## Application Setup + +You must first create a mysql database for Pydio Cells. Using our [mariadb image](https://hub.docker.com/r/linuxserver/mariadb) is recommended. + +Then access the web gui setup wizard at `https://SERVER_IP:8080` if accessing locally (must set `SERVER_IP` env var), or at `https://pydio-cells.domain.com` if reverse proxying. ## Usage @@ -60,7 +68,7 @@ services: ### docker cli -``` +```bash docker run -d \ --name=pydio-cells \ --hostname=pydio-cells \ @@ -76,7 +84,6 @@ docker run -d \ ghcr.io/linuxserver/pydio-cells ``` - ## Parameters Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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. @@ -88,7 +95,6 @@ Docker images are configured using parameters passed at runtime (such as those a | `8080` | Http port | | `33060` | gRPC port (required for CellsSync). | - ### Environment Variables (`-e`) | Env | Function | @@ -105,8 +111,8 @@ Docker images are configured using parameters passed at runtime (such as those a | :----: | --- | | `/config` | All the config files reside here. | - #### Miscellaneous Options + | Parameter | Function | | :-----: | --- | | `--hostname=` | Pydio Cells uses the hostname to verify local files. This setting is required and should not be changed after it has been set. | @@ -117,7 +123,7 @@ You can set any environment variable from a file by using a special prepend `FIL As an example: -``` +```bash -e FILE__PASSWORD=/run/secrets/mysecretpassword ``` @@ -128,7 +134,6 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/ 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. - ## 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`. @@ -137,24 +142,17 @@ Ensure any volume directories on the host are owned by the same user you specify In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: -``` +```bash $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` -## Application Setup - -You must first create a mysql database for Pydio Cells. Using our [mariadb image](https://hub.docker.com/r/linuxserver/mariadb) is recommended. - -Then access the web gui setup wizard at `https://SERVER_IP:8080` if accessing locally (must set `SERVER_IP` env var), or at `https://pydio-cells.domain.com` if reverse proxying. - - ## Docker Mods + [![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pydio-cells&query=%24.mods%5B%27pydio-cells%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=pydio-cells "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.") 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. - ## Support Info * Shell access whilst the container is running: