Linux install script that checks for Docker and installs Isopod

Open
#215 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
48/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
debian, docker, docker-compose, linux, typescript, ubuntu

Research direction

The issue names no script or test files, so first inspect the README Quick Start and the existing Docker Compose setup to find how host-Docker mode starts Isopod and stores data. Then identify the project’s install and deployment entry points and check how Docker installation and permissions can be handled on Ubuntu 24.04. Done means a fresh Ubuntu 24.04 install reaches the dashboard, reruns leave Docker unchanged, and the README leads with Linux.

Written by the indexing model from the issue text.

Description

enhancement

Blocked by #214.

Once servers can run on the host's Docker, Linux users should be able to install Isopod with one script instead of cloning the repo and running compose by hand.

Fix

An install script for Linux (Ubuntu/Debian first) that:

  • Checks for Docker and the compose plugin. If they're missing, installs them from Docker's official repository (asking first); if they're present, leaves them alone.
  • Handles permissions: run with sudo, or offer to add the user to the docker group, and say what that means security-wise.
  • Sets up Isopod in host-Docker mode, picks a data directory, and starts it.
  • Can be re-run safely to update or repair, without touching running servers.
  • Prints the dashboard URL and the reminder to keep it on the LAN or behind a VPN.

Also make the README's Quick Start lead with Linux, with the macOS and Windows notes after it.

Acceptance

  • On a fresh Ubuntu 24.04 VM, one command gets to a working dashboard.
  • Re-running it on a machine with Docker already installed changes nothing about Docker.
Dominant language
TypeScript
Stars
1
Forks
0
Avg merge
13h 12m
Merged PRs (30d)
57

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Isopod-Project/Isopod

All issues in Isopod-Project/Isopod

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.