Installation

Installation

There are several ways to install Recommendarr:

Option 1: Docker Hub Image (Easiest)

The simplest way to get started with Recommendarr:

# Pull and run with default port 3000
docker run -d \
  --name recommendarr \
  -p 3000:3000 \
  -v recommendarr-data:/app/server/data \
  tannermiddleton/recommendarr:latest

# Or run with a custom port (e.g., 8080)
docker run -d \
  --name recommendarr \
  -e PORT=8080 \
  -p 8080:8080 \
  -v recommendarr-data:/app/server/data \
  tannermiddleton/recommendarr:latest

Then visit http://localhost:3000 (or your custom port) in your browser.

Default Login:

• Username: admin
• Password: 1234

⚠️ IMPORTANT: Please change your password immediately after your first login for security reasons.

Option 2: Docker Compose

If you prefer using Docker Compose:

# Clone the repository (which includes the docker-compose.yml file)
git clone https://github.com/fingerthief/recommendarr.git
cd recommendarr

# Start the application
docker-compose up -d

This will:

1. Pull the pre-built image from Docker Hub
2. Configure proper networking and persistence
3. Start the unified service

Then visit http://localhost:3000 (or your custom port if configured) in your browser.

You can customize the port by setting the PORT environment variable before running docker-compose:

PORT=8080 docker-compose up -d

Option 3: Build Your Own Docker Image

If you want to build the Docker image yourself:

# Clone the repository
git clone https://github.com/fingerthief/recommendarr.git
cd recommendarr

# Build the Docker image
docker build -t recommendarr:local .

# Run the container with default port
docker run -d \
  --name recommendarr \
  -p 3000:3000 \
  -v recommendarr-data:/app/server/data \
  recommendarr:local

# Or run with custom port
docker run -d \
  --name recommendarr \
  -e PORT=8080 \
  -p 8080:8080 \
  -v recommendarr-data:/app/server/data \
  recommendarr:local

Option 4: Manual Installation

For development or if you prefer not to use Docker:

1. Clone the repository:

git clone https://github.com/fingerthief/recommendarr.git
cd recommendarr

2. Install dependencies:

npm install

3. Build the frontend:

npm run build

4. Start the unified server:

npm run unified

5. Visit http://localhost:3000 (or your custom port if configured) in your browser.