docker-documentation/docs/images/docker-codiad.md

144 wiersze
6.6 KiB
Markdown
Czysty Zwykły widok Historia

---
title: codiad
---
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read the https://github.com/linuxserver/docker-codiad/blob/master/.github/CONTRIBUTING.md -->
2019-02-07 01:43:17 +00:00
# DEPRECATION NOTICE
2019-02-07 01:43:17 +00:00
This image is deprecated. We will not offer support for this image and it will not be updated.
PLEASE MIGRATE TO CLOUD9 IF POSSIBLE `linuxserver/cloud9`
# [linuxserver/codiad](https://github.com/linuxserver/docker-codiad)
[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fcodiad?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fcodiad)
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-codiad.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-codiad)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-codiad.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-codiad/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-codiad/packages)
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-codiad/container_registry)
[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/codiad)
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/codiad.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/codiad)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/codiad.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/codiad)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-codiad%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-codiad/job/master/)
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fcodiad%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/codiad/latest/index.html)
[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-09-29 09:44:22 +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 |
2019-09-29 09:44:22 +00:00
| :---: | :--- |
2019-02-12 14:24:12 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 21:04:46 +00:00
| armhf | arm32v7-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-09-29 09:44:22 +00:00
```text
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-09-29 09:44:22 +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-09-29 09:44:22 +00:00
### Ports \(`-p`\)
2019-02-07 01:43:17 +00:00
2019-02-12 14:24:12 +00:00
| Parameter | Function |
2019-09-29 09:44:22 +00:00
| :---: | :--- |
2019-02-12 14:24:12 +00:00
| `80` | WebUI |
2019-02-07 01:43:17 +00:00
2019-09-29 09:44:22 +00:00
### Environment Variables \(`-e`\)
2019-02-07 01:43:17 +00:00
2019-02-12 14:24:12 +00:00
| Env | Function |
2019-09-29 09:44:22 +00:00
| :---: | :--- |
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-09-29 09:44:22 +00:00
### Volume Mappings \(`-v`\)
2019-02-07 01:43:17 +00:00
2019-02-12 14:24:12 +00:00
| Volume | Function |
2019-09-29 09:44:22 +00:00
| :---: | :--- |
2019-02-12 14:24:12 +00:00
| `/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-09-29 09:44:22 +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-09-29 09:44:22 +00:00
```text
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-06-11 10:30:03 +00:00
* **10.06.19:** - Deprecate Image.
2019-03-24 21:04:46 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
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.
2019-09-29 09:44:22 +00:00