/amet

:whale: Containerized Development Environment

Primary LanguageShellThe UnlicenseUnlicense

Amet

Containerized, portable development environment.

Introduction

The concept of this project is to create a development environment that utilizes Docker and Code-Server to create a fully functional, browser-based, portable development environment.

Quick Start

Clone the repo:

git clone git@github.com:Fluidbyte/amet.git

Run the script, supplying desired username and password for your development environment.

./amet.sh -u <username> -p <password> [-s <shell>]

Note: the <shell> can be bash or zsh (default: bash)

After this script completes the editor will be running at https://<HOST|IP>:3000. It will prompt you for the password you entered when running the script.

If you would like to access the environment over SSH:

ssh -p 3022 localhost

Just enter the password you specified above.

Customizing the Environment

The idea with this project is that your entire development environment is built as a container. Given this, the best way to customize your environment is to customize the ./Dockerfile to meet your needs.

Docker-in-Docker

The Docker container builds a docker client and service which can be used without conflicting with the host docker instance.

Persisting Data

When the container is started it will mount a volume to a /sync directory in the container and continually sync the /home/<username> directory. This directory will appear in the working directory where the ./amet.sh ... startup command was run.

Additionally, the following directories will be created (on first run) or synced internally (any subsequent runs):

  • ~/code-server: maintains all data, config, extensions, etc for Code-Server
  • ~/workspace: working environment that Code-Server opens initially

When you're ready to stop developing, you can shut down and restart the container without losing data, regardless of whether or not you're persisting volumes. Simply docker stop amet-USERNAME (fill in your username!) when you're done, and docker start amet-USERNAME when you're ready to start again. All your changes from the last run will be waiting for you.