Install on Unraid¶
Pantry Raider runs on Unraid two ways. Pick the one that fits how you already run things.
- Just the app (single container): you already run Grocy, or you want to install Grocy from Community Applications yourself and point Pantry Raider at it. This is the simplest route and the one most people want.
- The whole set (Compose stack): install Pantry Raider and Grocy together in one step with the Docker Compose Manager plugin (an optional Mealie can ride along for people who already use it).
Either way, Pantry Raider uses port 9284 and Grocy uses 9383 (an optional Mealie would use 9285).
Option 1: Just the app (single container)¶
This is the Community Applications template. Once it is published (see Submitting to Community Applications below), you install it like any other app.
- In Unraid, open the Apps tab (Community Applications).
- Search for Pantry Raider and click Install.
- Fill in the fields:
- WebUI Port: leave at 9284 unless it clashes with something.
- App Data: leave at
/mnt/user/appdata/pantryraiderso your setup survives updates. - Grocy Address: the address of your Grocy, for example
http://192.168.1.50:9383. No trailing slash. If you do not have Grocy yet, install the Grocy template from Community Applications first (set its version as described under Which Grocy?), then come back and fill this in. - Grocy API Key: leave it blank for a Grocy you just installed and have not signed in to yet. Pantry Raider signs in to it with Grocy's stock sign-in, creates its own key, and gives the Grocy admin account a new password (you can reveal it later in Settings, Inventory). For a Grocy you already use, open Manage API keys in Grocy and create one.
- Vision Provider and Gemini API Key: a free Google Gemini key from aistudio.google.com is the easiest start. You can also set these later.
- UI Password: set one here, or leave it blank and set it during the on-screen setup.
- The advanced fields (timezone, API key, Require Login, and a Mealie
address and key if you already use Mealie) are optional. Show them with
the Advanced View toggle. Keep Require Login at
true. - Click Apply, wait for it to start, then open the WebUI.
- Finish the short setup on the
/setuppage and you are done.
You do not have to fill everything into the template. Anything you leave blank
you can set on the /setup page after the app starts.
Option 2: The whole set (Compose stack)¶
Use this if you want Pantry Raider to bring its own Grocy along, all managed together.
- From the Apps tab, install the Docker Compose Manager plugin.
- Go to the Docker tab and scroll down to Compose Manager. Click
Add New Stack and name it
pantryraider. - Click the stack's cog, choose Edit Stack, then Compose File.
- Paste in the compose file from the project:
unraid/docker-compose.yml. It stores all data under/mnt/user/appdataand uses the same pinned backend versions the project ships. Recipes and meal plans are built in; the optional Mealie block starts out commented, for people who already use Mealie. - Save, then click Compose Up.
- Open
http://YOUR-UNRAID-IP:9284/setup. Pantry Raider finds the Grocy in the stack and sets it up on its own, so the wizard's Inventory step only needs you to wait for the green "ready" line. If you enabled the optional Mealie, enterhttp://YOUR-UNRAID-IP:9285in the wizard's Optional step.
Back up /mnt/user/appdata/pantryraider and /mnt/user/appdata/pantryraider-grocy
(your inventory) with the rest of your appdata, for example with the Appdata
Backup plugin.
Signing in and reaching it from outside¶
A Pantry Raider without a password answers only devices on your home network. To reach it through a reverse proxy or a tunnel, it needs a password, and signing in from outside your home network needs two-factor as well: turn on two-factor in Settings, Security from a device at home, then set the password. An install upgraded to 0.21 without a password keeps answering through a proxy for 14 days and shows a banner with the date it stops.
Set a password on the single-container install¶
The Community Applications template opens port 9284 on every address your server has, IPv6 included, and Unraid has no setting to limit it. Anyone who opens Pantry Raider over IPv6, and other containers on the same server (Home Assistant, for example), arrive through Docker's own gateway, so Pantry Raider cannot tell whether they are on your home network. Without a password it treats them as home. When it notices such a visitor it shows a notice saying so; set a password in Settings, Security and everyone signs in. The Compose stack (Option 2) publishes the port on IPv4 only, so it does not have this gap.
If you are locked out:
- Set a new password in the template's UI Password field and apply, which restarts the container.
- From a device at home, sign in with it and turn on two-factor in Settings, Security.
- If you can only reach Pantry Raider from outside, sign in with that
password anyway. The sign-in page explains that two-factor is needed and
offers Use the setup code instead. Follow it: opening that page writes
a code to the container's log. Open the log from the Docker tab, find the
newest line that begins
Pantry Raider setup code, and enter the code with your password. That signs you in once and takes you straight to turning on two-factor.
If Pantry Raider does not recognize your home network (for example a VPN such
as Tailscale), add the address range under Home networks in Settings,
Security, or in a LAN_CIDRS variable on the container, comma separated.
Which Grocy?¶
Grocy has its own Community Applications template already, so you can install it from the Apps tab and just point Pantry Raider at it. The Compose stack above is only for people who would rather run everything from one place.
When you install the Grocy template, change its Repository from
lscr.io/linuxserver/grocy to lscr.io/linuxserver/grocy:v4.7.1-ls346, the version
Pantry Raider is tested with. Left as it is, the template follows :latest,
so Unraid can move Grocy to a new release on its own, and a new Grocy release
can change its setup in a way that stops your inventory loading until you fix
it by hand (Grocy 4.7 did exactly that). With the version in the Repository,
Grocy only moves when you change that line. Back up Grocy's data folder before
you do, because Grocy upgrades its database on first start and cannot go back
to an older version on the same data.
Updating¶
- Single container: Unraid shows an update when a new release is
published and signed; the
latestimage never moves between releases. Your data in/mnt/user/appdata/pantryraiderstays put. - Compose stack: pull the new images and run Compose Up again, or pin a
version by setting
PANTRYRAIDER_TAG(or the olderFOODASSISTANT_TAG) in a.envnext to the compose file.
Grocy updated and inventory stopped loading¶
If Grocy updated itself (the Community Applications Grocy follows :latest
unless you set a version, see Which Grocy?) and Pantry Raider's inventory banner says Grocy "reported a problem with its
own setup" about AUTH_CLASS, Grocy 4.7 moved a class that your saved
config.php still points at. Back up config.php in Grocy's data folder
(/mnt/user/appdata/grocy/data for the CA template), change its AUTH_CLASS
line to Grocy\Middleware\Auth\DefaultAuthMiddleware, and press Refresh; no
restart needed. If Grocy signs you in through LDAP or a reverse proxy, keep
LdapAuthMiddleware or ReverseProxyAuthMiddleware and add Auth\ in the
same place instead (in the variable below too); the banner names the one your
Grocy uses. The full write-up, with a one-line command, is under
Grocy updated and inventory stopped loading.
The compose stack above can fix this on its own next time: step 4b in the
compose file drops a start-up script into Grocy that repairs the line.
If you run Grocy 4.7 or newer yourself and would rather not edit
config.php, you can fix the same error from the Grocy container's settings
instead: add a variable named GROCY_AUTH_CLASS with the value
Grocy\Middleware\Auth\DefaultAuthMiddleware and apply. Grocy uses that in
place of the line in config.php. Never set it on Grocy 4.6 or older: that
class does not exist there, and Grocy stops answering until you remove the
variable.
Submitting to Community Applications¶
These steps are for the project owner, to get the single-container template into
the Apps tab. See unraid/README.md
for the full detail.
- The template already lives in this repo at
unraid/pantryraider.xml, and itsTemplateURLpoints at the raw GitHub copy, so Community Applications can keep it in sync. - Sign in to the Community Applications submission portal at
https://ca.unraid.net/submit(the current source of truth for submission requirements) and add the repository, or use the older route: post in the Unraid Community Applications forum thread / send the moderators a private message with the repository URL. A moderator reviews it and adds the feed, usually within a couple of hours. - Community Applications runs automated checks (valid XML, no template pet-peeves). If anything is off, it shows up under Template Errors in CA settings and the app will not appear until it is fixed.