Installation

While the software is not complete and still has significant code to be developed if you insist on trying it out here's how to install it.

1. Download Docker Desktop on Windows or on Ubuntu:

   for pkg in docker.io docker-doc docker-compose docker-compose-v2 podman-docker containerd runc; do sudo apt-get remove $pkg; done

   Add Docker's official GPG key:

   sudo apt-get update sudo apt-get install ca-certificates curl sudo install -m 0755 -d /etc/apt/keyrings sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc sudo chmod a+r /etc/apt/keyrings/docker.asc

   Add the repository to Apt sources:

   echo
   "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu
   $(. /etc/os-release && echo "$VERSION_CODENAME") stable" |
   sudo tee /etc/apt/sources.list.d/docker.list > /dev/null sudo apt-get update

   Install and test Docker

   sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin docker-compose sudo groupadd docker sudo usermod -aG docker $USER

   docker run hello-world

   Hello world should run without a permission error, otherwise you missed something after the docker install.

   Total size in Docker is about 2.5GB.

2. In Docker desktop or Ubuntu open a terminal window, cd to where you want obsy to reside, and run:

   git clone https://www.github.com/gordtulloch/obsy.git cd obsy docker-compose build docker-compose up docker-compose run web python3 manage.py migrate docker-compose run web python3 manage.py createsuperuser (follow the prompts to create an initial superuser account)

   Connect to http://localhost:8000 and enter superuser credentials

Update Obsy

To update Obsy you need to pull the new version from Github then rebuild your docker containers.

cd obsy
docker-compose down
git pull
docker-compose build
docker-compose run web python3 manage.py migrate
docker-compose up

If you run into issues try

docker-compose build --no-cache

Which takes longer but builds everything from scratch.