README.md

TrueNAS helper scripts

A library of helpful scripts to manage TrueNAS

Tested on TrueNAS Scale 24.04

How to use (helper scripts)

First create a virtualenv and install the project.

All helper scripts can be used as Python modules (with python -m truenas_client.import_truenas_cert for example), or as a command (with import-truenas-cert). The commands will be used in the documentation below.

All command arguments can also be passed as environment variables, to avoid leaking tokens in shell history. For example, --truenas-url can be replaced by the environment variable TRUENAS_URL.

Import a certificate in TrueNAS

import-truenas-cert \
  --truenas-url=https://truenas.domain.or.ip/api/v2.0 \
  --truenas-api-key=<api key created on https://truenas.domain.or.ip/ui/apikeys> \
  --truenas-cert-name=<certificate name> \
  --cert-fullchain-path=<certificate path> \
  --cert-privatekey-path=<private key path>
  # Optional, add this if your TrueNAS cert is not trusted, e.g. for the first run
  # --truenas-ssl-verify=false

Python API client

A Python API client is being developed alongside the scripts, you can reuse and extend it as you see fit.

HTTP requests are made using HTTPX against the HTTP REST API (not the Websocket one), and API responses are parsed with Pydantic to ensure they look like what we expect.

You can find the TrueNAS REST API documentation at https://<truenas.domain.or.ip>/api/docs/#restful

References and inspirations

• TrueNAS server "middleware" (the code that runs their API)
• TrueNAS official Websocket client
• Async TrueNAS API client (unofficial, uses the Websocket API)
• Another async TrueNAS API client (unofficial, uses the REST API)
• TrueNAS cert updater
• deploy freenas