diff --git a/README.md b/README.md index f8e7af4..787ff28 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ Code-Server container optimized for daily use. You can download the image from the gitea embedded container registry: `gitea.ocram85.com/codeserver/arkanum` with these tags: -- `latest` - Is based on the lasted master banch commit. +- `latest` - Is based on the lasted master branch commit. - `next` - Is a test build based on the pull request - `1`, `0.1`, `0.1.0` - tag based version. See [packages page](https://gitea.ocram85.com/CodeServer/-/packages/container/arkanum/latest) for available tags. @@ -93,9 +93,42 @@ networks: ### Docker-Compose -### Docker CLI +This is a basic example for a `docker-compose` file from the [linuxserver/docker-code-server](https://github.com/linuxserver/docker-code-server) project. +See their [docs](https://github.com/linuxserver/docker-code-server#parameters) about a detailed help for advanced config parameters. +```yaml +--- +version: "3.8" +services: + code-server: + image: gitea.ocram85.com/codeserver/arkanum:0.0.1 + container_name: code-server + environment: + - PUID=1000 + - PGID=1000 + - TZ=Europe/London + - PASSWORD=password #optional + - HASHED_PASSWORD= #optional + - SUDO_PASSWORD=password #optional + - SUDO_PASSWORD_HASH= #optional + - PROXY_DOMAIN=code-server.my.domain #optional + - DEFAULT_WORKSPACE=/config/workspace #optional + volumes: + - /path/to/appdata/config:/config + ports: + - 8443:8443 + restart: unless-stopped +``` + +### First Steps + +After summon Arkanum your first steps should be to set your username and email in the git config: + +``` +git config --global user.name "username" +git config --global user.email "email address" +``` ## 📖 Content

@@ -109,11 +142,11 @@ networks: ### 🚀 Starship prompt -The [Starship](starship.rs) prompt is added and enabled as default. Default config uses Emojis and FiraCode icons. +We added the [Starship](starship.rs) prompt is as default in the integrated terminal. The default config uses Emojis and FiraCode icons. ### 🔱 git config -Adds default git system config file with: +Added default git system config file with: - code-server as default editor. - disabled `aurocrlf`. @@ -123,9 +156,9 @@ Adds default git system config file with: > 💡 See [gitconfig-system](./gitconfig-system) for details. -### 🧙 Added `arkanum` helper script +### 🧙 `arkanum` helper -Added `arkanum` to help installing common runtime in container. +Added `arkanum` to help installing common runtimes in container. This helps reducing the image size. ``` @@ -190,12 +223,10 @@ arkanum --install-extensions arkanum --reset-codesetting # Reload with command F1 + Developer: Reload Window ``` -## A word about Github - -== We're Using GitHub Under Protest == +## We're Using GitHub Under Protest This project is currently **mirrored** to GitHub. This is not ideal; GitHub is a -proprietary, trade-secret system that is not Free and Open Souce Software +proprietary, trade-secret system that is not Free and Open Source Software (FOSS). We are deeply concerned about using a proprietary system like GitHub to develop our FOSS project. We have an [open Gitea repository ](https://gitea.ocram85.com/CodeServer/arkanum/issues) where the