Skip to content

Instructions for Running FermiBottle on Linux Systems

Alex Reustle edited this page May 14, 2024 · 4 revisions

Installing Docker

FermiBottle requires Docker, which happily runs natively on Linux. If you do not already have Docker installed, you can install it using either your system's package manager or one of the official docker binaries.

If you are running a popular distribution of Linux such as Ubuntu, Debian, Fedora, or CentOS please refer to your distributions page here:

Otherwise, check your system's package manager or help documentation.

Advanced Installation Options

If the Docker RPM repository does not yet have binaries for your version of Linux, you need to use the community repositories and enable permissions yourself.

  1. Install Docker sudo apt install docker.io
  2. Allow your user account to use docker sudo usermod -a -G docker $USER
  3. Start the docker daemon sudo systemctl start docker
  4. Make the docker daemon a startup process sudo systemctl enable docker
  5. Reboot.

Acquire the Docker Image

The FermiBottle image is an approximately 3 GB file that is hosted on Docker Hub. You can download it using a Docker pull command:

docker pull fssc/fermibottle

Prepare your shared directory

The shared directory is a folder on your host machine whose contents are also visible inside the container. Our default instructions are going to ensure that everyone is working from the same shared directory in the same location, but if you are clever you can point this anywhere else on your machine.

mkdir $HOME/shared

Create a container from the FermiBottle image

  1. Create a new FermiBottle container by copying this block of code into your command line and running it:
docker create -it --init \
-e HOST_USER_ID=`id -u $USER` \
-e DISPLAY=$DISPLAY \
-v /tmp/.X11-unix:/tmp/.X11-unix \
-v "$HOME/shared":/shared \
-p 8888:8888 \
fssc/fermibottle

The big string of numbers and letters that gets printed out is your Container ID. That can be hard to remember so you may instead want to use the NAME. These should both be listed for you if you run docker ps -a.

If you were successful, we recommend you Do Not make duplicate containers by running docker create again. It can be frustrating if you lose track of which one all of your work was done in if it wasn't saved to the shared directory.

Now you can proceed to Using the FermiBottle container.