Quick start

This page walks through the first setup in order: sign in, add a downloader, sign in to your sites, subscribe to an RSS feed, start RSS tasks and confirm the first automatic download. If pt-tools is not installed yet, start with Install.

1. Sign in and change the password

Open http://your-server:8080, sign in with the initial account (see "Signing in for the first time" in Install), then change the password under System → Change password (系统 → 修改密码).

2. Add a downloader

1. Open Downloads → Downloader settings (下载 → 下载器设置) and choose Add downloader (添加下载器).
2. Choose qBittorrent or Transmission and enter its web UI address, user name and password.
3. After saving, the Connectivity (连通性) column of the list shows whether pt-tools can reach it; the check button on the row runs the check again.
4. With more than one downloader, click the star to make your usual one the default.

Download folders, disk protection and the other options are described in Configuration.

3. Sign in to your sites

Open Sites → Site list (站点 → 站点列表), choose a site and fill in its credentials on the Credentials (凭据) tab. Sites sign in in different ways:

• Cookie: most NexusPHP sites. The PT Tools Helper browser extension syncs the cookie in one click once you are signed in to the site.
• API key: M-Team, for example.
• Passkey: Rousi Pro, for example (enter the site's personal API key; see Cookies and API keys).

Where to find them is explained in Cookies and API keys. After saving, the Status (状态) column of the site list shows whether the site can be reached.

4. Subscribe to RSS

1. On the site's page, open the RSS subscriptions (RSS 订阅) tab and add a feed.
2. Enter a name and the RSS link and choose a downloader; you can also choose a download folder, a check interval and filter rules.
3. After saving, start RSS tasks as described in the next section; only then is the feed fetched at its interval.

WARNING

A feed with no filter rules attached downloads freeleech torrents only. To follow a series or download torrents that are not free, create a filter rule first and turn off its Free only (仅免费) option if needed.

How to find a site's RSS link and what each option does is covered in RSS subscriptions.

5. Start RSS tasks and turn on auto-start

RSS tasks fetch the feeds at their intervals and push torrents. Auto-start is off by default, so start them by hand the first time:

1. Click RSS tasks (RSS 任务) at the left end of the status bar at the bottom (on a phone, the panel is under Me (我的) in the bottom tabs), then click Start (启动) in the panel that opens.
2. In the same panel, turn on Start when the program starts (程序启动时自动运行). From then on RSS tasks run whenever the program starts, including after a container restart or an upgrade.

While auto-start is off and RSS tasks are not running, a notice at the top of each page says RSS tasks are not running (RSS 任务没有运行), with Start RSS tasks (启动 RSS 任务) and Turn on auto-start (打开自动启动) buttons. What RSS tasks cover and when they do not run is explained in Configuration.

6. Add filter rules if you need them

Open Rules → Filter rules (规则 → 过滤规则), choose Add rule (添加规则), enter a keyword, wildcard or regular expression, then attach the rule to the RSS feed. The syntax and examples for TV series are in Filter rules and TV series. Downloading freeleech only needs no rules.

7. Confirm the first automatic download

• RSS tasks (RSS 任务) in the status bar shows whether they are running; when they are not, open it to see why.
• Downloads → Task list (任务列表) lists every torrent that was pushed, with its freeleech end time and push status.
• Downloads → Downloader web UI (下载器 Web UI) shows each torrent's progress in the downloader itself.
• When a push fails, or nothing matched, System → Logs (运行日志) records the reason.

8. Back up the key

Copy secret.key from the data folder, together with the database, to another device. Without the key, saved cookies cannot be decrypted. Backing up and restoring are covered in Upgrades and backups.

What next

• Subscribe to films and follow series, with finished downloads filed into your media library: under Media → Media library (媒体 → 媒体库), click Add (添加) next to Media library (媒体库) to create a library, and turn on Automatic organising (自动整理) under Organise settings (整理设置); turn on the Subscriptions (订阅) switch in Subscription settings (订阅设置) at the bottom of Media → Follow and subscribe (媒体 → 追剧与订阅); then, in Media → Explore (媒体 → 探索), click Subscribe (订阅) on a film or Follow (追剧) on a series. See Follow and subscribe and Media library organising.
• Check and manage pt-tools from your phone: under System → Remote access (系统 → 远程访问), turn on Remote access (远程访问) and save, click Add device (添加设备) to show a QR code, and pair with Scan QR code in the app. See Mobile app.
• Ask about your data and search for torrents in plain language: under System → AI assistant settings (系统 → AI 助手设置), pick a provider, enter the API key, pick a model, click Test connection (测试连接), turn on Enable AI assistant (启用 AI 助手) and save; then chat under Overview → AI assistant (概览 → AI 助手). See AI assistant.
• See each day's state on one page: the home page you land on has the NAS overview, today's episodes and the things that need attention, and System → System check (系统 → 系统体检) checks the services and settings. See Home page and system check.
• Get notifications and send commands from a chat app: ChatOps quick start
• Remove old torrents automatically when disk space runs low: Auto-delete and disk protection
• Get a reminder before an inactive account is disabled: Login status and key backup