kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
39e68aa8d2
commit
3b63da3c34
|
|
@ -1,11 +1,20 @@
|
|||
# linuxserver/codimd
|
||||
# [linuxserver/codimd](https://github.com/linuxserver/docker-codimd)
|
||||
|
||||
[](https://github.com/linuxserver/docker-codimd) [](https://github.com/linuxserver/docker-codimd/releases) [](https://github.com/linuxserver/docker-codimd/packages) [](https://gitlab.com/Linuxserver.io/docker-codimd/container_registry) [](https://microbadger.com/images/linuxserver/codimd) [](https://hub.docker.com/r/linuxserver/codimd) [](https://hub.docker.com/r/linuxserver/codimd) [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-codimd/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/codimd/latest/index.html)
|
||||
[](https://github.com/linuxserver/docker-codimd)
|
||||
[](https://github.com/linuxserver/docker-codimd/releases)
|
||||
[](https://github.com/linuxserver/docker-codimd/packages)
|
||||
[](https://gitlab.com/Linuxserver.io/docker-codimd/container_registry)
|
||||
[](https://microbadger.com/images/linuxserver/codimd "Get your own version badge on microbadger.com")
|
||||
[](https://hub.docker.com/r/linuxserver/codimd)
|
||||
[](https://hub.docker.com/r/linuxserver/codimd)
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-codimd/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/codimd/latest/index.html)
|
||||
|
||||
[Codimd](https://demo.codimd.org) gives you access to all your files wherever you are.
|
||||
|
||||
CodiMD is a real-time, multi-platform collaborative markdown note editor. This means that you can write notes with other people on your desktop, tablet or even on the phone. You can sign-in via multiple auth providers like Facebook, Twitter, GitHub and many more on the homepage.
|
||||
|
||||
|
||||
## 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/).
|
||||
|
|
@ -15,18 +24,19 @@ Simply pulling `linuxserver/codimd` should retrieve the correct image for your a
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v7-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```text
|
||||
```
|
||||
docker create \
|
||||
--name=codimd \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -43,6 +53,7 @@ docker create \
|
|||
linuxserver/codimd
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -83,22 +94,24 @@ services:
|
|||
- TZ=Europe/London
|
||||
ports:
|
||||
- "3000:3000"
|
||||
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Ports \(`-p`\)
|
||||
### Ports (`-p`)
|
||||
|
||||
| Parameter | Function |
|
||||
| :---: | :--- |
|
||||
| `3000` | If you wish to access this container from [http://{IP}:${PORT}\`](http://{IP}:${PORT}`) this _must_ be left unchanged. |
|
||||
| :----: | --- |
|
||||
| `3000` | If you wish to access this container from http://{IP}:${PORT}` this *must* be left unchanged. |
|
||||
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
|
||||
| Env | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `DB_HOST=<hostname or ip>` | Host address of mysql database |
|
||||
|
|
@ -108,19 +121,21 @@ Docker images are configured using parameters passed at runtime \(such as those
|
|||
| `DB_NAME=codimd` | Database name |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||
|
||||
### Volume Mappings \(`-v`\)
|
||||
### Volume Mappings (`-v`)
|
||||
|
||||
| Volume | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `/config` | CodiMD config and configurable files |
|
||||
|
||||
## Environment variables from files \(Docker secrets\)
|
||||
|
||||
|
||||
## Environment variables from files (Docker secrets)
|
||||
|
||||
You can set any environment variable from a file by using a special prepend `FILE__`.
|
||||
|
||||
As an example:
|
||||
|
||||
```text
|
||||
```
|
||||
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
||||
```
|
||||
|
||||
|
|
@ -128,24 +143,26 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/
|
|||
|
||||
## Umask for running applications
|
||||
|
||||
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.
|
||||
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`.
|
||||
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`.
|
||||
|
||||
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
|
||||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```text
|
||||
```
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
||||
## Application Setup
|
||||
|
||||
CodiMD web interface can be accessed `http://${IP}:3000/`, if you want to use a custom domain or anything besides port 3000 you will need to leverage their env settings for callbacks: \(specifically for CMD\_DOMAIN and CMD\_URL\_ADDPORT\)
|
||||
CodiMD web interface can be accessed `http://${IP}:3000/`, if you want to use a custom domain or anything besides port 3000 you will need to leverage their env settings for callbacks: (specifically for CMD_DOMAIN and CMD_URL_ADDPORT)
|
||||
|
||||
[Full list of CodiMD options](https://github.com/codimd/server/blob/master/docs/configuration-env-vars.md)
|
||||
|
||||
|
|
@ -153,11 +170,12 @@ For convience we provide a working example using Mysql as a backend in this docu
|
|||
|
||||
To run behind a reverse proxy we have a [preconfigured config](https://github.com/linuxserver/reverse-proxy-confs/blob/master/codimd.subdomain.conf.sample) using docker networking included in our [LetsEncrypt](https://github.com/linuxserver/docker-letsencrypt) image and you can read how to use this in the [Reverse Proxy Confs repository](https://github.com/linuxserver/reverse-proxy-confs/#how-to-use-these-reverse-proxy-configs)
|
||||
|
||||
|
||||
## Docker Mods
|
||||
[](https://mods.linuxserver.io/?mod=codimd "view available mods for this container.")
|
||||
|
||||
[](https://mods.linuxserver.io/?mod=codimd)
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
## Support Info
|
||||
|
||||
|
|
@ -173,4 +191,3 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
|||
## Versions
|
||||
|
||||
* **23.05.19:** - Initial release
|
||||
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue