Watcharr

https://watcharr.app/docs
Admin
Watcharr is a self-hosted application that allows users to maintain a personal list of movies and TV...
Tokens:3,365
Snippets:76
Trust Score:5.5
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install server dependencies

Source: https://watcharr.app/docs/installation/for-development

Install server dependencies in the `server` folder.

```bash
go get .
```

--------------------------------

### Install frontend dependencies

Source: https://watcharr.app/docs/installation/for-development

Install frontend dependencies in the project root folder.

```bash
npm i
```

--------------------------------

### Build the frontend

Source: https://watcharr.app/docs/installation/from-source

Installs frontend dependencies, builds the frontend, and moves the build output to the server's UI folder.

```bash
npm i && \
npm run build && \
mv ./build ./server/ui  

```

--------------------------------

### Docker Compose Configuration

Source: https://watcharr.app/docs/installation/docker-compose

Example docker-compose.yml file for setting up Watcharr.

```yaml
services:
  watcharr:
    # The :latest tag is used for simplicity, it is recommended
    # to use an actual version, then when updating check the releases for changelogs.
    image: ghcr.io/sbondco/watcharr:latest
    container_name: watcharr
    ports:
      - 3080:3080
    volumes:
      # Contains all of watcharr data (database & cache)
      - ./data:/data
    restart: unless-stopped

```

--------------------------------

### Start Watcharr

Source: https://watcharr.app/docs/installation/docker-compose

Command to start Watcharr using Docker Compose.

```bash
docker compose up -d

```

--------------------------------

### Text File Example

Source: https://watcharr.app/docs/importing/text-file

An example of a text file import, showing entries with and without years.

```text
The Terminator (1984)  
Breaking Bad  
A Fistful of Dollars  
Reacher (2022)  


```

--------------------------------

### Update Image Version

Source: https://watcharr.app/docs/installation/docker-compose

Example of updating the image version in docker-compose.yml.

```yaml
# eg. update v1.19.0 to v1.20.0 (or whatever version you are updating to)
image: ghcr.io/sbondco/watcharr:v1.19.0

```

--------------------------------

### Build the server

Source: https://watcharr.app/docs/installation/from-source

Navigates to the server directory, downloads Go modules, and builds the server binary for Linux.

```bash
cd server && \
go mod download && \
GOOS=linux go build -o ./watcharr  

```

--------------------------------

### Run the frontend

Source: https://watcharr.app/docs/installation/for-development

Run the frontend development server from the project root folder.

```bash
npm run dev
```

--------------------------------

### Run the server

Source: https://watcharr.app/docs/installation/for-development

Run the server development server from the project root folder.

```bash
npm run server
```

--------------------------------

### Run the server

Source: https://watcharr.app/docs/installation/from-source

Executes the Watcharr server binary.

```bash
./watcharr  

```

--------------------------------

### Manually run the server on Windows

Source: https://watcharr.app/docs/installation/for-development

Manually run the server on Windows, setting the MODE environment variable in PowerShell.

```powershell
cmd /V /C "set MODE=DEV&& go run ."
```

--------------------------------

### Clone the repository

Source: https://watcharr.app/docs/installation/from-source

Clones the Watcharr repository and navigates into the directory.

```bash
git clone https://github.com/sbondCo/Watcharr.git && \
cd Watcharr  

```

--------------------------------

### Clone the repository

Source: https://watcharr.app/docs/installation/for-development

Clone your forked Watcharr repository to your local machine.

```bash
git clone https://github.com/<your username>/Watcharr.git && \
cd Watcharr
```

--------------------------------

### Checkout a specific version tag

Source: https://watcharr.app/docs/installation/from-source

Checks out a specific version tag of the Watcharr repository.

```bash
git checkout <tag>  

```

--------------------------------

### Set CGO_ENABLED environment variable

Source: https://watcharr.app/docs/installation/for-development

Set the CGO_ENABLED environment variable for Go.

```bash
go env -w CGO_ENABLED=1
```

--------------------------------

### Pull the latest code

Source: https://watcharr.app/docs/installation/from-source

Pulls the latest changes from the repository.

```bash
git pull  

```

--------------------------------

### Text File Format

Source: https://watcharr.app/docs/importing/text-file

The format for the text file import requires each line to be a new entry. The name of the content (show/movie) must be provided, and the year can be optionally provided surrounded by brackets.

```text
<name> [(<year>)]  

```

--------------------------------

### Pull New Changes and Recreate Container

Source: https://watcharr.app/docs/installation/docker-compose

Commands to pull new Docker images and restart the Watcharr container.

```bash
docker compose pull && docker compose down && docker compose up -d

```
Tokens:
Raw