Ubuntu i3 Docker Image

A Docker image based on Ubuntu with the i3 window manager, providing a lightweight and efficient desktop environment.

Overview

This repository contains configuration files and documentation for using the pixelllab/ubuntu-i3 Docker image.

Prerequisites

Before you can use this container, you need to have the following installed on your host machine:

• Docker
• GPU drivers (for GPU support)
• A VNC viewer application (such as TigerVNC Viewer, RealVNC, or any other compatible VNC client)

To install TigerVNC Viewer:

• On Ubuntu/Debian: sudo apt-get install tigervnc-viewer
• On Windows: Download from TigerVNC website
• On macOS: Use Homebrew brew install --cask tigervnc-viewer

How to Run

Pull the Docker Image

To pull the Docker image from Docker Hub:

docker pull pixelllab/ubuntu-i3

Run the Container

To run the container, simply use:

./start

Then connect to the container using a VNC client at localhost:5901.

Stop the Container

To stop the running container:

./stop

Save Container State

To save your container as a new image:

./save

Using Scripts

This repository includes several utility scripts to manage your container:

• start.sh: Launches the container with GPU, audio support, and proper port mapping. This script starts the container, opens a VNC viewer in fullscreen mode, and connects you to the container's bash shell.

• save.sh: Commits the current state of the running container back to the base image, preserving all your changes. This allows you to keep your modifications for future container runs.

• kill.sh: Saves the current container state similar to save.sh, then stops and removes the container completely. Use this when you want to shut down the container after saving its state.

• enter.sh: A simple script that lets you open a new bash shell in the running container. Useful when you need another terminal without restarting the container.

• backup.sh: Creates a timestamped backup image of the current container state. Unlike save.sh which overwrites the original image, this creates a new image with a timestamp, allowing you to maintain multiple versions.

Example:

./start    # Start the container
./stop     # Stop the container
./save     # Save container changes

Features

• Ubuntu base system
• i3 window manager
• Minimal resource requirements
• Easy to customize

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.