2019-02-12 14:24:12 +00:00
# [linuxserver/codiad](https://github.com/linuxserver/docker-codiad)
2019-02-07 01:43:17 +00:00
2019-02-12 14:24:12 +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/codiad.svg )](https://microbadger.com/images/linuxserver/codiad "Get your own version badge on microbadger.com")
[![ ](https://images.microbadger.com/badges/image/linuxserver/codiad.svg )](https://microbadger.com/images/linuxserver/codiad "Get your own version badge on microbadger.com")
![Docker Pulls ](https://img.shields.io/docker/pulls/linuxserver/codiad.svg )
![Docker Stars ](https://img.shields.io/docker/stars/linuxserver/codiad.svg )
[![Build Status ](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-codiad/master )](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-codiad/job/master/)
[![ ](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/codiad/latest/badge.svg )](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/codiad/latest/index.html)
2019-02-07 01:43:17 +00:00
2019-02-12 14:24:12 +00:00
[Codiad ](http://codiad.com/ ) is a web-based IDE framework with a small footprint and minimal requirements. We have added a few plugins. More can be added in the marketplace in the WebUI.
2019-02-07 01:43:17 +00:00
2019-02-12 14:24:12 +00:00
## Supported Architectures
2019-02-07 01:43:17 +00:00
2019-02-28 01:42:36 +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-07 01:43:17 +00:00
2019-02-12 14:24:12 +00:00
Simply pulling `linuxserver/codiad` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2019-02-07 01:43:17 +00:00
2019-02-12 14:24:12 +00:00
The architectures supported by this image are:
| Architecture | Tag |
| :----: | --- |
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v6-latest |
2019-02-07 01:43:17 +00:00
## Usage
2019-02-12 14:24:12 +00:00
Here are some example snippets to help you get started creating a container from this image.
### docker
2019-02-07 01:43:17 +00:00
```
docker create \
2019-02-12 14:24:12 +00:00
--name=codiad \
2019-03-07 01:42:48 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-12 14:24:12 +00:00
-e TZ=Europe/London \
-p 80:80 \
-v < path to data > :/config \
--restart unless-stopped \
linuxserver/codiad
```
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
codiad:
image: linuxserver/codiad
container_name: codiad
environment:
2019-03-07 01:42:48 +00:00
- PUID=1000
- PGID=1000
2019-02-12 14:24:12 +00:00
- TZ=Europe/London
volumes:
- < path to data > :/config
ports:
- 80:80
restart: unless-stopped
2019-02-07 01:43:17 +00:00
```
## Parameters
2019-02-12 14:24:12 +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-07 01:43:17 +00:00
2019-02-12 14:24:12 +00:00
### Ports (`-p`)
2019-02-07 01:43:17 +00:00
2019-02-12 14:24:12 +00:00
| Parameter | Function |
| :----: | --- |
| `80` | WebUI |
2019-02-07 01:43:17 +00:00
2019-02-12 14:24:12 +00:00
### Environment Variables (`-e`)
2019-02-07 01:43:17 +00:00
2019-02-12 14:24:12 +00:00
| Env | Function |
| :----: | --- |
2019-03-07 01:42:48 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-12 14:24:12 +00:00
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
2019-02-07 01:43:17 +00:00
2019-02-12 14:24:12 +00:00
### Volume Mappings (`-v`)
2019-02-07 01:43:17 +00:00
2019-02-12 14:24:12 +00:00
| Volume | Function |
| :----: | --- |
| `/config` | Where Codiad stores data. |
2019-02-07 01:43:17 +00:00
2019-02-12 14:24:12 +00:00
## User / Group Identifiers
2019-02-07 01:43:17 +00:00
2019-02-12 14:24:12 +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-07 01:43:17 +00:00
2019-02-12 14:24:12 +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-02-07 01:43:17 +00:00
2019-03-07 01:42:48 +00:00
In this instance `PUID=1000` and `PGID=1000` , to find yours use `id user` as below:
2019-02-07 01:43:17 +00:00
2019-02-12 14:24:12 +00:00
```
$ id username
2019-03-07 01:42:48 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-12 14:24:12 +00:00
```
2019-02-07 01:43:17 +00:00
2019-02-12 14:24:12 +00:00
## Support Info
2019-02-07 01:43:17 +00:00
2019-02-12 14:24:12 +00:00
* Shell access whilst the container is running:
* `docker exec -it codiad /bin/bash`
* To monitor the logs of the container in realtime:
* `docker logs -f codiad`
* Container version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' codiad`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/codiad`
2019-02-07 01:43:17 +00:00
## Versions
2019-02-24 17:31:24 +00:00
* **22.02.19:** - Rebasing to alpine 3.9, adding ssh client.
2019-02-12 14:24:12 +00:00
* **16.01.19:** - Add pipeline logic and multi arch.
* **26.09.18:** - Add sed to init file to configure projects folder correctly.
* **04.09.18:** - Rebase to alpine linux 3.8.
* **09.01.18:** - Rebase to alpine linux 3.7.
* **25.05.17:** - Rebase to alpine linux 3.6.
* **18.02.17:** - Rebase to alpine linux 3.5.
* **14.10.16:** - Add version layer information.
* **10.09.16:** - Add layer badges to README.
* **06.11.15:** - Initial Release.