Skip to content

Online Installation (Linux)

When to Use Online Installation

Online installation is the recommended method for most users because it:

  • Simplifies the process: Single command downloads and configures everything automatically
  • Ensures latest versions: Always pulls the most current Osprey images and components
  • Reduces errors: Automated script handles complex configuration steps
  • Saves time: No need to manually download and manage installation files

Choose online installation when:

  • Your server has reliable internet access
  • You can access Docker Hub and Azure storage endpoints
  • You want the simplest installation experience
  • You need the latest version of Osprey

Installation Steps

Step 1: Install Docker and Docker Compose

Ubuntu

# Quick one-liner installation
curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh

# Install Docker Compose
sudo apt update
sudo apt install -y docker-compose

# Start and enable Docker service
sudo systemctl start docker
sudo systemctl enable docker

# Add current user to docker group
sudo usermod -aG docker $USER
sudo newgrp docker

Verify Docker Installation

# Check Docker version
docker --version

# Check Docker Compose version
docker compose version

# Test Docker installation
sudo docker run hello-world

Note: If you added your user to the docker group, you will need log out and log back in for the changes to take effect.

Step 2: Run Bootstrap Script

Run the following command as root or with sudo:

sudo curl -fsSL https://tychodataosprey.blob.core.windows.net/images/bootstrap.sh | bash

This script will automatically:

  • Download the latest Osprey Docker images
  • Download and configure PostgreSQL database
  • Set up docker-compose configuration
  • Configure Docker networking and ports
  • Initialize the database with required schemas
  • Start all services

Monitoring Installation Progress

During installation, you'll see output similar to:

Downloading Osprey platform image...
Downloading PostgreSQL image...
Downloading Traefik image...
Creating docker-compose configuration...
Starting services...
Initializing database...
Installation complete!

The installation typically takes 10-30 minutes depending on internet speed and server performance.

Post-Installation Verification

Check Service Status

Verify all containers are running:

# Check container status
docker compose ps

# Check container health
docker-compose logs

# View real-time resource usage
docker stats --no-stream

Test Web Access

Remote access test: From another machine, navigate to: http://<server-ip>/

Set up account

From another machine, navigate to: http://<server-ip>/start Navigate the set up screens. An initial login will be created for you.

Troubleshooting Common Issues

Docker Permission Issues

If you get a permission denied error such as either of the below:

⚠ Added user to docker group. Please log out and back in, then run this script again.
permission denied while trying to connect to the Docker daemon socket at unix:///var/run/docker.sock

This is the most common issue. Follow these steps:

  1. Add your user to the docker group: bash sudo usermod -aG docker $USER

Internet Connectivity Issues

If the script fails to download images:

# Verify Docker Hub access
curl -I https://index.docker.io

# Check Azure storage access
curl -I https://tychodataosprey.blob.core.windows.net

# Test DNS resolution
nslookup tychodataosprey.blob.core.windows.net

Download Timeouts

If downloads fail due to timeouts:

# Check network stability
ping -c 4 google.com

# Try manual download to test connectivity
curl -O https://tychodataosprey.blob.core.windows.net/images/osprey_1.0.122.tar

# Restart Docker service
sudo systemctl restart docker

# Try installation again
curl -fsSL https://tychodataosprey.blob.core.windows.net/images/bootstrap.sh | bash

Firewall Configuration

Ensure firewall allows external access:

Ubuntu

# Allow HTTP and HTTPS
sudo ufw allow 80/tcp
sudo ufw allow 443/tcp

# Check firewall status
sudo ufw status

Upgrades

To upgrade Osprey to a newer version:

1. Stop Current Services

docker compose down

2. Update Version in Configuration

Open docker-compose.yml and update the Osprey image version to the latest version provided by the Tycho Data team.

Example:

services:
  app:
    image: tychodata/osprey:1.0.125  # Update to new version number

3. Start Updated Services

docker compose up -d

4. Verify Upgrade

Check that all containers are running with the new version:

# Check container status
docker compose ps

# Verify image versions
docker images | grep osprey

Note: Always backup your configuration and data before performing upgrades.

Next Steps

Once the installation is complete and verified, proceed to create your administrator account:

Next: Create Administrator Account