# 快速开始

## 安装 Polaris

### Docker Compose 方式安装

最简单使用本程序的方式是通过docker compose，下面内容保存成 docker-compose.yml，然后执行 `docker compose up -d`, 即可拉起程序。

```yaml
services:
  polaris:
    image: ghcr.io/simon-ding/polaris:latest
    restart: always
    volumes:
      - ./config/polaris:/app/data #程序配置文件路径
      - /downloads:/downloads #下载路径，需要和下载客户端配置一致
      - /data:/data #媒体数据存储路径，也可以启动自己配置webdav存储
    ports:
      - 8080:8080
```

### Docker 方式安装

也可以通过原始 docker 命令的方式安装 Polaris：

<pre class="language-bash"><code class="lang-bash"><strong>docker run -d \
</strong>    -v &#x3C;your config path>:/app/data
    -v &#x3C;your downlaod path>:/downloads
    -v &#x3C;your media data path>:/data
    -p 8080:8080
    --restart always
    ghcr.io/simon-ding/polaris:latest
</code></pre>

拉起之后访问 http\://< ip >:8080 即可访问 Polaris 的主页：

<figure><img src="https://1617180474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMhNRiyTL8EfM4awaUYnW%2Fuploads%2FnVZhcHvB02XczXo82a5Z%2Fimage.png?alt=media&#x26;token=4f2ed9fe-bece-4ac9-825b-88e457c0d2a6" alt=""><figcaption></figcaption></figure>

## 安装 Transmission

Polaris 需要下载客户端的配合使用。推荐使用 Transmission，安装transmission的方法见：

* [linuxserver/transmission](https://docs.linuxserver.io/images/docker-transmission/)

需要注意的是 transmission 内 /downloads 路径的映射地址要和 Polaris的/downloads路径映射保持一致。也就是说他俩都要映射到同一路径。

## 安装 Jackett

Polaris 如果要正常工作，还需要一个索引客户端的支持，目前支持jackett索引客户端。

安装方式见：

* [linuxserver/jackett](https://docs.linuxserver.io/images/docker-jackett/)

## 联合安装

如果觉得一个个安装麻烦，也可以使用下面docker compose文件，一键拉起所有组件

```yaml
services:
  polaris:
    image: ghcr.io/simon-ding/polaris:latest
    restart: always
    volumes:
      - ./config/polaris:/app/data #程序配置文件路径
      - /downloads:/downloads #下载路径，需要和下载客户端配置一致
      - /data:/data #媒体数据存储路径，也可以启动自己配置webdav存储
    ports:
      - 8080:8080
  transmission:    #下载客户端，也可以不安装使用已有的
    image: lscr.io/linuxserver/transmission:latest
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Asia/Shanghai
    volumes:
      - ./config/transmission:/config
      - /downloads:/downloads #此路径要与polaris下载路径保持一致
    ports:
      - 9091:9091
      - 51413:51413
      - 51413:51413/udp
  jackett:      #索引客户端，也可以不安装使用已有的
    image: lscr.io/linuxserver/jackett:latest
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Asia/Shanghai
    volumes:
      - ./config/jackett:/config
    ports:
      - 9117:9117
    restart: unless-stopped
```

复制上面文件保存成 docker-compose.yml 文件，然后执行下面命令

```bash
docker compose up -d
```

## 配置

安装完成之后，请前往[配置篇](https://simonding.gitbook.io/polaris/an-zhuang-yu-pei-zhi/setup)，配置Polaris，以使程序能正常工作
