The main goal of DockSTARTer is to make it quick and easy to get up and running with Docker.

You may choose to rely on DockSTARTer for various changes to your Docker system or use DockSTARTer as a stepping stone and learn to do more advanced configurations.

Getting Started

System Requirements

• You must be running a supported platform or an operating system based on a supported platform. Platforms named below will link to documentation listing compatible versions.
• You must be logged in as a non-root user with sudo permissions.

One Time Setup (required)

• APT Systems (Debian, Ubuntu, etc)

  sudo apt-get install curl git
  # You will need not root user. If you plan use Coder we recommend create user `coder` :
  sudo useradd -m coder
  # You will be asked for new password for `coder`
  sudo passwd coder
  # User must have priviledges of sudoers to install Docker:
  echo "coder ALL=(ALL:ALL) ALL" >> /etc/sudoers.d/coder
  # Start session for `coder`:
  su - coder
  # Execute install:
  bash -c "$(curl -fsSL https://get.dockstarter.com)"
  sudo reboot

  Tip for Windows local developing

  N.B. :If you are on Windows and want to replicate you plugins from your local VS Code environment to remote docker, just copy %HOME%.vscode\extensions (usually like C:\Users\itsmeohgotuser.vscode\extensions) to remote host (usually like /home/coder/.config/appdata/codeserver/extensions/) and NOT forget to run following coomands on docker hosting machine:

  # stop container
   sudo docker stop codeserver
  
  # change windows paths to actual paths after that in extensions.json file:
   sed -i.bak 's/\/c:\/Users\/itsmeohgotuser\/.vscode\/extensions\//\/config\/extensions\//' /home/coder/.config/appdata/codeserver/extensions/extensions.json
  
  # start container again
   sudo docker start codeserver

  Raspbian requires a few extra commands

  sudo apt-get update
  sudo apt-get dist-upgrade
  sudo apt-get install curl git
  bash -c "$(curl -fsSL https://get.docker.com)"
  bash -c "$(curl -fsSL https://get.dockstarter.com)"
  sudo reboot

  OpenMediaVault (OMV) requires special instructions found here

• DNF Systems (Fedora)

  sudo dnf install curl git
  bash -c "$(curl -fsSL https://get.dockstarter.com)"
  sudo reboot

• Pacman Systems (Arch, Manjaro, EndeavourOS, etc.)

  sudo pacman -Sy curl docker git
  bash -c "$(curl -fsSL https://get.dockstarter.com)"
  sudo reboot

• YUM Systems (CentOS)

  sudo yum install curl git
  bash -c "$(curl -fsSL https://get.dockstarter.com)"
  sudo reboot

Alternate install (any system)

The standard install above downloads the initial script using a method with some known risks. For those concerned with the security of the above method, here is an alternative:

## NOTE: Run the appropriate command for your distro
sudo apt-get install curl git
sudo dnf install curl git
sudo pacman -Sy curl git
sudo yum install curl git

Then

git clone https://github.com/GhostWriters/DockSTARTer "/home/${USER}/.docker"
bash /home/"${USER}"/.docker/main.sh -vi
sudo reboot

Running DockSTARTer

ds

To run DockSTARTer, use the command above. You should now see the main menu from the screenshots. Select Configuration and then Full Setup, and you will be guided through selecting apps and starting containers.

See our documentation for more detailed information.

Support

Click the chat badge to join us on Discord for support!

Feature Request | Bug Report

Additional information can be found on our Support Page.

Contributing

Want to help develop DockSTARTer? Check out our contributing guidelines and code of conduct.

Contributors

This project exists thanks to all the people who contribute.

Supporters

Support the project by donating on Open Collective.

Backers

Thank you to all our backers! Become a backer.

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. Become a sponsor.

Special Thanks

• SmartHomeBeginner.com for creating AtoMiC-ToolKit that served as this project's primary inspiration, and later this guide that provided some initial direction with Docker.
• LinuxServer.io for maintaining most Docker images used in this project.