Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion .github/renovate.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,23 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [
"config:base"
"config:base",
"default:automergeDigest",
"helpers:pinGitHubActionDigestsToSemver"
],
"minimumReleaseAge": "7 days",
"internalChecksFilter": "strict",
"packageRules": [
{
"description": "Automerge GitHub Actions updates, including majors, when checks pass",
"matchManagers": ["github-actions"],
"automerge": true
},
{
"description": "Automerge non-major npm/yarn updates when checks pass",
"matchManagers": ["npm"],
"matchUpdateTypes": ["minor", "patch", "pin", "digest"],
"automerge": true
}
]
}
18 changes: 10 additions & 8 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,24 @@ jobs:
build:
name: Build Content
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- uses: actions/checkout@v6
- uses: codespell-project/actions-codespell@v2
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- uses: codespell-project/actions-codespell@8f01853be192eb0f849a5c7d721450e7a467c579 # v2.2
with:
check_hidden: true
path: docs
- name: Run Markdown Lint
uses: actionshub/markdownlint@main
- uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7.0.0
with:
path: docs
- uses: actions/setup-go@v6
- uses: actions/setup-node@v6
go-version: stable
- uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
with:
node-version: 24.x
node-version: 24
cache: yarn
- name: Install Dependencies
run: yarn install --frozen-lockfile
- name: Lint Markdown
run: yarn lint
- name: Build website
run: yarn build
16 changes: 12 additions & 4 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,20 @@ jobs:
deploy:
name: Deploy to GitHub Pages
runs-on: ubuntu-latest
permissions:
contents: write
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- uses: actions/checkout@v6
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
ref: ${{ inputs.branch || 'main' }}
- uses: actions/setup-node@v6
- uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7.0.0
with:
node-version: latest
go-version: stable
- uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
with:
node-version: 24
cache: yarn
- name: Install Dependencies
run: yarn install --frozen-lockfile
Expand All @@ -35,8 +42,9 @@ jobs:
# Popular action to deploy to GitHub Pages:
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
uses: peaceiris/actions-gh-pages@84c30a85c19949d7eee79c4ff27748b70285e453 # v4.1.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Build output to publish to the `gh-pages` branch:
publish_dir: build
cname: unpackerr.zip
24 changes: 24 additions & 0 deletions .markdownlint-cli2.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"config": {
"MD001": false,
"MD002": false,
"MD007": { "indent": 2 },
"MD013": { "line_length": 110, "tables": false, "code_blocks": true },
"MD025": false,
"MD026": false,
"MD030": false,
"MD031": false,
"MD033": false,
"MD034": false,
"MD037": false,
"MD041": false,
"MD046": false,
"MD049": false,
"MD050": false
},
"ignores": [
"docs/install/generated/**",
"node_modules/**",
"build/**"
]
}
10 changes: 0 additions & 10 deletions .mdlrc

This file was deleted.

3 changes: 0 additions & 3 deletions .style

This file was deleted.

4 changes: 2 additions & 2 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
```
MIT LICENSE.
Copyright (c) 2018-2022 David Newhall II
Copyright (c) 2023-2024 Go Lift - Building Strong Go Tools
Copyright (c) 2023-2026 Go Lift Technologies, LLC

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
Expand All @@ -21,4 +21,4 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```
```
68 changes: 6 additions & 62 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,69 +1,13 @@
# unpackerr.zip

[This repository](https://github.com/Unpackerr/unpackerr.github.io)
contains the source and files that create [https://unpackerr.zip](https://unpackerr.zip).

## Website

This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.

## Installation

Clone the repo, then cd into the new folder and run this first.
Source for [https://unpackerr.zip](https://unpackerr.zip). Built with [Docusaurus 3](https://docusaurus.io/).

```console
yarn install
yarn start # local dev server
yarn build # production build
yarn lint # markdownlint-cli2 (same as CI)
codespell docs # brew install codespell
```

## Local Development

**Use this when developing locally!**

This command starts a local development server and open up a browser window.
Most changes are reflected live without having to restart the server.

```console
yarn start
```

## Build

This command generates static content into the `build` directory and can be served using apache or nginx, etc.

```console
yarn build
```

## Deployment

Github Actions automatically builds the `main` branch and pushes it to the `gh-pages` branch.

## Contributing

1. Fork the repo.
1. Make your changes; test them with `yarn`.
1. Test `docs/` with `mdl docs` and `codespell docs`.
1. Make a pull request.
1. Bug me on [Discord](https://golift.io/discord) if I don't respond in a timely manner.

## MDL Linter

To run the linter locally, I had to do this on my Mac, but `bundler` may work too.
GH actions runs a newer version than 0.11.0, but this worked for me for _something_.

```shell
brew install rbenv ruby-build
rbenv install 3.2.2
eval "$(rbenv init -)"
rbenv shell 3.2.2
gem install --no-document mdl
mdl -g docs
```

Seriously, run mdl before committing.

## Codespell Linter

```shell
brew install codespell
```
Push to `main` deploys to GitHub Pages.
3 changes: 0 additions & 3 deletions babel.config.js

This file was deleted.

4 changes: 2 additions & 2 deletions docs/install/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ UN_FOLDER_1_PATH=/data/downloads/games/
Anything that [has a header](https://github.com/Unpackerr/unpackerr/blob/main/examples/unpackerr.conf.example#L99)
with double brackets `[[..]]` can be repeated as many times as you'd like.

<!-- The Global content is generated from here: https://github.com/Unpackerr/unpackerr/tree/main/init/config -->
{/* The Global content is generated from here: https://github.com/Unpackerr/unpackerr/tree/main/init/config */}
<Global />

## Secrets and Passwords
Expand Down Expand Up @@ -116,7 +116,7 @@ Then store the API key (and only the API key) in `/etc/secrets/radarr.txt`.
_<font color="gray">This feature was added in Unpackerr v0.14.0.</font>_
:::

<!-- This content is generated from here: https://github.com/Unpackerr/unpackerr/tree/main/init/config -->
{/* This content is generated from here: https://github.com/Unpackerr/unpackerr/tree/main/init/config */}
<Generated/>

## Event IDs
Expand Down
2 changes: 1 addition & 1 deletion docs/install/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ This image is effectively identical to the DockerHub version; use whichever you
The `latest` tag is always a [tagged release on GitHub](https://github.com/Unpackerr/unpackerr/releases).

- Pull the GHCR image with this command:
```
```shell
docker pull ghcr.io/unpackerr/unpackerr:latest
```

Expand Down
16 changes: 9 additions & 7 deletions docs/install/unraid.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Unpackerr is available in the
[Community Applications](https://github.com/selfhosters/unRAID-CA-templates/blob/main/templates/unpackerr.xml)
on unRAID. Install it from the `Apps` page; see screenshot that follows.

![](/img/screenshots/unraid/install1.png "install")
![Community Applications Unpackerr install](/img/screenshots/unraid/install1.png "install")

On the install screen, fill in the `URL` and `API_KEY` for one or more of the Starr apps.

Expand All @@ -26,7 +26,7 @@ hooks. There is no limit to how many you may configure.
It's also recommend that you set a log file.
It's recommended to put it in your downloads location, and an example follows.

![](/img/screenshots/unraid/bindvolume.png "bind volume")
![Bind volume for Unpackerr log file](/img/screenshots/unraid/bindvolume.png "bind volume")

:::tip Download Location
The most common misconfiguration on unRAID, by far, and it's not even a close second, is
Expand All @@ -36,33 +36,35 @@ not what you want. **Do this:**

1. Go into Unraid.
1. Click on Docker.
1. Enable Advanced View; toggle is in the top-right. ![](/img/screenshots/unraid/advancedview.png "advanced view")
1. Enable Advanced View; toggle is in the top-right.

![Enable Docker advanced view](/img/screenshots/unraid/advancedview.png "advanced view")
1. Look at the mounts for Sonarr and/or Radarr.
You're looking for the one that begins with `/data <->` or `/downloads <->`.
1. You want to make sure Unpackerr looks *identical*. See below.

![](/img/screenshots/unraid/starrmounts.png "starr mounts")
![Starr app volume mounts](/img/screenshots/unraid/starrmounts.png "starr mounts")

If the highlighted portions above are not identical to the one below, then things are bound to work poorly.
In other words, if Unpackerr has `/downloads <-> /mnt/user/downloads` and Sonarr has
`/data <-> /mnt/user/downloads`, Unpackerr will not be able to find your files. In this hypothetical, you
must edit the Unpackerr `/downloads` mount, and change the _Container Path_ to `/data` so it matches Sonarr.

![](/img/screenshots/unraid/unpackerrmount.png "unapackerr mount")
![Unpackerr volume mount](/img/screenshots/unraid/unpackerrmount.png "unapackerr mount")
:::

## Permissions

Set the UID and GID by adding `--user uid:gid` to the `Extra Parameters`
section of the unraid template after enabling the `Advanced` view.
![](/img/screenshots/unraid/advancedview.png "advanced view")
![Enable Docker advanced view](/img/screenshots/unraid/advancedview.png "advanced view")
You must make these match your starr app so hard links work correctly.
**Other containers, use env variables such as `PUID` and `PGID`, but the
Go Lift unpackerr container does not use these.**
e.g. If Sonarr has `PUID` of `99` and `PGID` of `100`, then you must
add **`--user 99:100`** to `Extra Parameters` as shown below.

![](/img/screenshots/unraid/extraparameters.png "extra parameters")
![Unpackerr Extra Parameters UID and GID](/img/screenshots/unraid/extraparameters.png "extra parameters")

## Video Guide

Expand Down
Loading
Loading