Skip to content
master
Switch branches/tags
Code

DockSTARTer

Supporters on Open Collective Discord chat GitHub contributors GitHub last commit master GitHub license GitHub Workflow Status

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.

Main Menu

App Select

Value Prompt

Command Line Interface

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
    bash -c "$(curl -fsSL https://get.dockstarter.com)"
    sudo reboot

    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
  • YUM Systems (CentOS)

    sudo yum install curl git
    bash -c "$(curl -fsSL https://get.dockstarter.com)"
    sudo reboot
  • Pacman Systems (Arch, Manjaro, EndeavourOS, etc.)

    Note that systems with the pacman package manager will not install docker via the https://get.docker.com script that is used for other distros. The instructions below provide information on installing all the required packages manually before installing DockSTARTer.

    sudo pacman -Sy curl docker 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 yum install curl git
sudo pacman -Sy curl docker git

Then

git clone https://github.com/GhostWriters/DockSTARTer "/home/${USER}/.docker"
sudo 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

Discord chat

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

Feature Request | Bug Report

Additional information can be found on our Support Page.

Contributors

GitHub contributors

This project exists thanks to all the people who contribute. GitHub contributors

Supporters

Support the project by donating on Open Collective.

Backers

Backers on Open Collective

Thank you to all our backers! Become a backer.

Backers on Open Collective

Sponsors

Sponsors on Open Collective

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

Sponsors on Open Collective Sponsors on Open Collective Sponsors on Open Collective Sponsors on Open Collective Sponsors on Open Collective Sponsors on Open Collective Sponsors on Open Collective Sponsors on Open Collective Sponsors on Open Collective Sponsors on Open Collective

Special Thanks