Skip to content

Commit

Permalink
docs: Add standalone installation section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Clon1998 committed Nov 30, 2024
1 parent 67ef129 commit 34e2bd9
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ Companion for [Mobileraker](https://github.com/Clon1998/mobileraker), enabling p
- [Using the Installer](#using-the-installer)
- [Installation via Kiauh](#installation-via-kiauh)
- [Run the Companion in Docker](#run-the-companion-in-docker)
- [Standalone Installation](#standalone-installation)
- [Key Benefits](#key-benefits)
- [Installation Requirements](#installation-requirements-1)
- [Quick Installation Steps](#quick-installation-steps)
- [Manual Installation](#manual-installation)
- [Companion - Multi-Printer](#companion---multi-printer)
- [Companion - Config](#companion---config)
Expand Down Expand Up @@ -118,6 +122,33 @@ services:
> [!WARNING]
> Adjust the paths in the volume mounts to point to your `mobileraker.conf` file.

## Standalone Installation

Mobileraker Companion offers a flexible standalone installation option for Debian-based systems, ideal for deploying on separate hardware with limited resources. This mode allows you to run the companion on a machine independent of your 3D printer's primary system.

### Key Benefits
- **Independent Deployment**: Run on a separate device from your 3D printer
- **Resource Efficiency**: Suitable for systems with minimal computing resources
- **Flexible Monitoring**: Simplified setup for distributed monitoring

### Installation Requirements
- Debian-based Linux distribution
- Git
- Basic command-line familiarity

### Quick Installation Steps

1. Open your terminal
2. Navigate to your home directory
3. Clone the Mobileraker Companion repository
4. Run the standalone installer

```bash
cd ~/
git clone https://github.com/Clon1998/mobileraker_companion.git
./mobileraker_companion/scripts/install.sh -standalone
```

## Manual Installation

For a manual installation, follow these steps:
Expand Down

0 comments on commit 34e2bd9

Please sign in to comment.