Portainer Templates logo

Portainer Templates

Codiad Codiad

Container

Productivity

Codiad is a web-based IDE framework with a small footprint and minimal requirements.

Image details

Pulls: 2.4M
Architecture: amd64, arm64, arm, arm64/v8
Image size: 27 MB
User: linuxserver
Created: Nov 07, 2015
Updated: 7 years ago
Status: active

Configuration

Type
Container
Platform
linux
Image
linuxserver/codiad:latest
Ports
80/tcp
Volumes
/config : /portainer/Files/AppData/Config/Codiad
Env vars
PUID=1000PGID=100
Restart
unless-stopped

Template by mikestraney

Standalone Install

Select an install method, to see config/commands for deploying Codiad

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Codiad, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation.

undefinedlinuxserver.io
The LinuxServer.io team brings you another container release featuring :-
regular and timely application updates easy user mappings (PGID, PUID) custom base image with s6 overlay weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth regular security updates
Find us at:
  • Discord - realtime support / chat with the community and the team.
  • IRC - on freenode at #linuxserver.io. Our primary support channel is Discord.
  • Blog - all the things you can do with our containers including How-To guides, opinions and much more!

linuxserver/codiad

Docker Pulls Docker Stars Build Status
THIS IMAGE IS DEPRECATED. PLEASE MIGRATE TO CLOUD9 IF POSSIBLE linuxserver/cloud9 Codiad 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.
codiad

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 and our announcement here.
Simply pulling linuxserver/codiad should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
ArchitectureTag
x86-64amd64-latest
arm64arm64v8-latest
armhfarm32v7-latest

Usage

Here are some example snippets to help you get started creating a container.

docker

docker create \
  --name=codiad \
  -e PUID=1000 \
  -e PGID=1000 \
  -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.

```

version: "2" services: codiad:
image: linuxserver/codiad
container_name: codiad
environment:
  - PUID=1000
  - PGID=1000
  - TZ=Europe/London
volumes:
  - path to data:/config
ports:
  - 80:80
restart: unless-stopped
## Parameters

Container 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.


<table><thead><tr><th>Parameter</th><th>Function</th></tr></thead><tbody><tr><td><code>-p 80</code></td><td>WebUI</td></tr><tr><td><code>-e PUID=1000</code></td><td>for UserID - see below for explanation</td></tr><tr><td><code>-e PGID=1000</code></td><td>for GroupID - see below for explanation</td></tr><tr><td><code>-e TZ=Europe/London</code></td><td>Specify a timezone to use EG Europe/London.</td></tr><tr><td><code>-v /config</code></td><td>Where Codiad stores data.</td></tr></tbody></table>

## 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`.

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:
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
 


## Support Info

* 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`

## Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.  
  
Below are the instructions for updating containers:  
  
### Via Docker Run/Create
* Update the image: `docker pull linuxserver/codiad`
* Stop the running container: `docker stop codiad`
* Delete the container: `docker rm codiad`
* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
* Start the new container: `docker start codiad`
* You can also remove the old dangling images: `docker image prune`

### Via Docker Compose
* Update all images: `docker-compose pull`
  * or update a single image: `docker-compose pull codiad`
* Let compose update all containers as necessary: `docker-compose up -d`
  * or update a single container: `docker-compose up -d codiad`
* You can also remove the old dangling images: `docker image prune`

### Via Watchtower auto-updater (especially useful if you don't remember the original parameters)
* Pull the latest image at its tag and replace it with the same env variables in one run:
  ```
  docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  containrrr/watchtower \
  --run-once codiad
  ```
* You can also remove the old dangling images: `docker image prune`

## Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic: 
git clone https://github.com/linuxserver/docker-codiad.git cd docker-codiad docker build \ --no-cache \ --pull \ -t linuxserver/codiad:latest .
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
docker run --rm --privileged multiarch/qemu-user-static:register --reset ```
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

  • 10.06.19: - Deprecate Image.
  • 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
  • 22.02.19: - Rebasing to alpine 3.9, adding ssh client.
  • 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.

Serve Codiad on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying codiad.example.com to http://codiad:80

Add this to your Caddyfile

codiad.example.com {
	reverse_proxy http://codiad:80
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs codiad
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Published on a random port

This template exposes 80/tcp without setting a host port, so Docker picks a random free one on every deploy.

  • Find it in the Ports column of Portainer's container list, or with docker port codiad

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:100 /portainer/Files/AppData/Config/Codiad
  • Or set the PUID and PGID variables (defaults 1000:100) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull linuxserver/codiad:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64, arm, arm64/v8
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect codiad --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Codiad runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Codiad needs bundled into one download. This template pulls linuxserver/codiad:latest, which Docker fetches once (about 27 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Codiad's comes from Docker Hub, published by linuxserver.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, arm, arm64/v8, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. Here the app exposes a port but leaves the host side blank, so Docker picks a free one for you. It opens:

  • 80, published on a random host port

Volumes

A volume is where Codiad keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /config from /portainer/Files/AppData/Config/Codiad on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Codiad takes 2 of them, all with defaults you can leave alone or tweak:

  • PUID, defaults to 1000
  • PGID, defaults to 100

Restart policy

The restart policy here is unless-stopped, so Docker restarts Codiad after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Nothing custom is set, so Codiad sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container codiad. That's what you'll spot in the containers list and use in commands like docker logs codiad.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Codiad up. Add the template list to Portainer once, then deploying Codiad is a click rather than a wall of config.