Skip to content
Snippets Groups Projects
Commit f60c32a1 authored by Griefed's avatar Griefed :joystick:
Browse files

Update README according to template

parent 4374e230
No related branches found
No related tags found
No related merge requests found
# ICEcoder-Container
https://github.com/icecoder/ICEcoder in a container!
[![ICEcoder](https://i.griefed.de/images/2020/10/18/icecoder.png)](https://github.com/icecoder/ICEcoder)
![Docker Pulls](https://img.shields.io/docker/pulls/griefed/icecoder?style=flat-square)
![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/griefed/icecoder?label=Image%20size&sort=date&style=flat-square)
![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/griefed/icecoder?label=Docker%20build&style=flat-square)
![Docker Cloud Automated build](https://img.shields.io/docker/cloud/automated/griefed/icecoder?label=Docker%20build&style=flat-square)
![GitHub Repo stars](https://img.shields.io/github/stars/Griefed/docker-ICEcoder?label=GitHub%20Stars&style=social)
![GitHub forks](https://img.shields.io/github/forks/Griefed/docker-ICEcoder?label=GitHub%20Forks&style=social)
[![Docker Pulls](https://img.shields.io/docker/pulls/griefed/icecoder?style=flat-square)](https://hub.docker.com/repository/docker/griefed/icecoder)
[![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/griefed/icecoder?label=Image%20size&sort=date&style=flat-square)](https://hub.docker.com/repository/docker/griefed/icecoder)
[![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/griefed/icecoder?label=Docker%20build&style=flat-square)](https://hub.docker.com/repository/docker/griefed/icecoder)
[![Docker Cloud Automated build](https://img.shields.io/docker/cloud/automated/griefed/icecoder?label=Docker%20build&style=flat-square)](https://hub.docker.com/repository/docker/griefed/icecoder)
[![GitHub Repo stars](https://img.shields.io/github/stars/Griefed/docker-ICEcoder?label=GitHub%20Stars&style=social)](https://github.com/Griefed/docker-ICEcoder)
[![GitHub forks](https://img.shields.io/github/forks/Griefed/docker-ICEcoder?label=GitHub%20Forks&style=social)](https://github.com/Griefed/docker-ICEcoder)
Creates a Container which runs [icecoder's](https://github.com/icecoder) [ICEcoder](https://github.com/icecoder/ICEcoder) with, [php:alpine](https://hub.docker.com/_/php) as the base image, as seen on https://icecoder.net/
ICEcoder is a browser based code editor, which provides a modern approach to building websites. By allowing you to code directly within the web browser, online or offline, it means you only need one program (your browser) to develop sites, plus can test on actual web servers. After development, you can also maintain the website easily, all of which make for speedy and smart development.
---
# Deploy with docker-compose:
```
Creates a Container which runs [icecoder's](https://github.com/icecoder) [ICEcoder](https://github.com/icecoder/ICEcoder), with [lsiobase/alpine](https://hub.docker.com/r/lsiobase/alpine) as the base image, as seen on https://icecoder.net/.
The lasiobase/alpine image is a custom base image built with [Alpine linux](https://alpinelinux.org/) and [S6 overlay](https://github.com/just-containers/s6-overlay).
Using this image allows us to use the same user/group ids in the container as on the host, making file transfers much easier
## Deployment
### Pre-built images
```docker-compose.yml
version: '3.6'
services:
icecoder:
container_name: icecoder
image: griefed/icecoder
restart: unless-stopped
volumes:
- ./icecoder/config:/config
- ./icecoder/data:/data
- ./icecoder/plugins:/plugins
environment:
- GITURL=https://github.com/icecoder/ICEcoder.git
- PUID=1000
- PGID=1000
- TZ=Europe/Berlin
ports:
- 8080:8080
```
### Deploy on Rasbperry Pi
Using the Dockerfile, this container can be built and run on a Raspberry Pi, too! I've tested it on a Raspberry Pi 3B+.
Simply put the Dockerfile in a directory called `ICEcoder` in the same directory as your docker-compose.yml, edit your docker-compose.yml:
## Configuration
Configuration | Explanation
------------ | -------------
restart | [Restart policy](https://docs.docker.com/compose/compose-file/#restart) Either: "no", always, on-failure, unless-stopped
volumes | /config contains all relevant configuration files.
volumes | /data contains all relevant data like code. /data/code is the directory where GITURL is cloned into, for example.
volumes | /plugins contains all plugin files.
GITURL | Specify a GitHub repository to checkout on first run of the container.
TZ | Timezone
PUID | for UserID
PGID | for GroupID
ports | The port where the service will be available at.
## User / Group Identifiers
When using volumes, permissions issues can arise between the host OS and the container. [Linuxserver.io](https://www.linuxserver.io/) avoids 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)
```
### Raspberry Pi & building the image yourself
Using the [Dockerfile](https://github.com/Griefed/docker-ICEcoder/blob/lsiobase/alpine/Dockerfile), this container can be built and run on a Raspberry Pi.
I've tested it on a Raspberry Pi 3B.
#### docker-compose.yml
```docker-compose.yml
version: '3.6'
services:
icecoder:
container_name: icecoder
build: ./ICEcoder/
build: ./icecoder/
restart: unless-stopped
volumes:
- ./icecoder/config:/config
- ./icecoder/data:/data
- ./icecoder/plugins:/plugins
environment:
- GITURL=https://github.com/icecoder/ICEcoder.git
- PUID=1000
- PGID=1000
- TZ=Europe/Berlin
ports:
- 8080:8080
```
Then build with:
```
docker-compose up -d --build icecoder
```
1. Clone the repository: `git clone https://github.com/Griefed/docker-ICEcoder.git ./icecoder`
1. Prepare docker-compose.yml file as seen above
1. `docker-compose up -d --build icecoder`
1. Visit IP.ADDRESS.OF.HOST:8080
1. ???
1. Profit!
![ICEcoder](https://i.imgur.com/hNjOkVK.png)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment