kupferbootstrap/docs/source/install.md
2022-11-10 02:25:05 +01:00

1,012 B

Installation

  1. Install Python 3, Docker, and git.

    On Arch: pacman -S python docker git --needed --noconfirm

    After installing Docker you will have to add your user to the `docker` group:
    
    `sudo usermod -aG docker "$(whoami)"`
    
    Then restart your desktop session for the new group to take effect.
    
  2. Pick which Kupferbootstrap branch to clone: usually either main or dev

  3. Clone the repository: git clone -b INSERT_BRANCHNAME_HERE https://gitlab.com/kupfer/kupferbootstrap

  4. Change into the folder: cd kupferbootstrap

  5. Install python dependencies: pip3 install -r requirements.txt

    Most of our python dependencies are available as distro packages on most distros,
    sadly it's incomplete on Arch.
    
    See `requirements.txt` for the list of required python packages.
    
  6. Symlink kupferbootstrap into your $PATH: sudo ln -s "$(pwd)/bin/kupferbootstrap" /usr/local/bin/

  7. You should now be able to run kupferbootstrap --help!