Backup and Restore - Single Line Installer on Debian

[imager2019]

I am experiencing difficulties performing backup and restore functions from a Single Line Installation on Debian.

Very new to Linux, so most of these are likely my issues coming from a Windows background.

Inventree is setup to perform daily automatic backup, and these are being completed and stored in /opt/inventree/data/backup . My problems start is when I want to perform a manual backup or restore and receive similar results.

My first step is to execute the activate command, which I perform from as follows along with the source function:

inventree@debian:~$ cd /opt/inventree
inventree@debian:/opt/inventree$ source ./env/bin/activate
(env) inventree@debian:

After this, I attempt to perform a restore, and receive the following:

(env) inventree@debian:/opt/inventree$ invoke restore
Restoring InvenTree database...
load version from file
Traceback (most recent call last):
  File "/opt/inventree/InvenTree/manage.py", line 23, in <module>
    execute_from_command_line(sys.argv)
  File "/opt/inventree/env/lib/python3.9/site-packages/django/core/management/__init__.py", line 419, in execute_from_command_line
    utility.execute()
  File "/opt/inventree/env/lib/python3.9/site-packages/django/core/management/__init__.py", line 363, in execute
    settings.INSTALLED_APPS
  File "/opt/inventree/env/lib/python3.9/site-packages/django/conf/__init__.py", line 82, in __getattr__
    self._setup(name)
  File "/opt/inventree/env/lib/python3.9/site-packages/django/conf/__init__.py", line 69, in _setup
    self._wrapped = Settings(settings_module)
  File "/opt/inventree/env/lib/python3.9/site-packages/django/conf/__init__.py", line 170, in __init__
    mod = importlib.import_module(self.SETTINGS_MODULE)
  File "/usr/lib/python3.9/importlib/__init__.py", line 127, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 1030, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1007, in _find_and_load
  File "<frozen importlib._bootstrap>", line 986, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 680, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 790, in exec_module
  File "<frozen importlib._bootstrap>", line 228, in _call_with_frames_removed
  File "/opt/inventree/InvenTree/InvenTree/settings.py", line 116, in <module>
    STATIC_ROOT = config.get_static_dir()
  File "/opt/inventree/InvenTree/InvenTree/config.py", line 230, in get_static_dir
    raise FileNotFoundError('INVENTREE_STATIC_ROOT not specified')
FileNotFoundError: INVENTREE_STATIC_ROOT not specified
(env) inventree@debian:/opt/inventree$

If I try to execute a manual backup, I receive the following:

(env) inventree@debian:/opt/inventree$ invoke backup
Backing up InvenTree database...
load version from file
Traceback (most recent call last):
  File "/opt/inventree/InvenTree/manage.py", line 23, in <module>
    execute_from_command_line(sys.argv)
  File "/opt/inventree/env/lib/python3.9/site-packages/django/core/management/__init__.py", line 419, in execute_from_command_line
    utility.execute()
  File "/opt/inventree/env/lib/python3.9/site-packages/django/core/management/__init__.py", line 363, in execute
    settings.INSTALLED_APPS
  File "/opt/inventree/env/lib/python3.9/site-packages/django/conf/__init__.py", line 82, in __getattr__
    self._setup(name)
  File "/opt/inventree/env/lib/python3.9/site-packages/django/conf/__init__.py", line 69, in _setup
    self._wrapped = Settings(settings_module)
  File "/opt/inventree/env/lib/python3.9/site-packages/django/conf/__init__.py", line 170, in __init__
    mod = importlib.import_module(self.SETTINGS_MODULE)
  File "/usr/lib/python3.9/importlib/__init__.py", line 127, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 1030, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1007, in _find_and_load
  File "<frozen importlib._bootstrap>", line 986, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 680, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 790, in exec_module
  File "<frozen importlib._bootstrap>", line 228, in _call_with_frames_removed
  File "/opt/inventree/InvenTree/InvenTree/settings.py", line 116, in <module>
    STATIC_ROOT = config.get_static_dir()
  File "/opt/inventree/InvenTree/InvenTree/config.py", line 230, in get_static_dir
    raise FileNotFoundError('INVENTREE_STATIC_ROOT not specified')
FileNotFoundError: INVENTREE_STATIC_ROOT not specified
(env) inventree@debian:/opt/inventree$ 

This looks to be the same type of error/warning. I have not edited or changed any of the config files - should they need to be manually edited?
Thoughts and assistance would be appreciated as I am stumped where to look next or how to proceed.

Thanks..

[SchrodingersGat]

Your static directory should either be specified in your .config.yaml file or via environment variable. Can you share your config file (with any private data redacted)?

Are you installing bare metal or with the installer?

[SchrodingersGat]

Further comment here:

Running from /opt/inventree (even with the correct venv activated) does not work, because the configuration is not being loaded from /etc/inventree/config.yaml. This is because the environment variables are not globally set. You need to run inventree run cli restore for both the venv and the environment variables to be set correctly.

[imager2019]

@SchrodingersGat - My system is setup on Debian 11 using the Quick Script install method.

The .config.yaml file actually exists in two places on the system. One in /etc/inventree while the other is in /opt/inventree/invenTree. The second (in /opt/inventree/invenTree) is locked and I believe is not the one to be edited/used (can you confirm that?).

Below is the config.yaml file from /etc/inventree:

# Secret key for backend
# Use the environment variable INVENTREE_SECRET_KEY_FILE
secret_key_file: '/etc/inventree/secret_key.txt'

# Database backend selection - Configure backend database settings
# Documentation: https://docs.inventree.org/en/latest/start/config/

# Note: Database configuration options can also be specified from environmental variables,
#       with the prefix INVENTREE_DB_
#       e.g INVENTREE_DB_NAME / INVENTREE_DB_USER / INVENTREE_DB_PASSWORD
database:
  # Uncomment (and edit) one of the database configurations below,
  # or specify database options using environment variables

  # Refer to the django documentation for full list of options

  # --- Available options: ---
  # ENGINE: Database engine. Selection from:
  #         - mysql
  #         - postgresql
  #         - sqlite3
  # NAME: Database name
  # USER: Database username (if required)
  # PASSWORD: Database password (if required)
  # HOST: Database host address (if required)
  # PORT: Database host port (if required)

  # --- Database settings ---
  ENGINE: sqlite3
  NAME: '/opt/inventree/data/database.sqlite3'
  USER: sampleuser
  PASSWORD: samplepassword
  HOST: samplehost
  PORT: 123456

  # --- Example Configuration - MySQL ---
  #ENGINE: mysql
  #NAME: inventree
  #USER: inventree
  #PASSWORD: inventree_password
  #HOST: 'localhost'
  #PORT: '3306'

  # --- Example Configuration - Postgresql ---
  #ENGINE: postgresql
  #NAME: inventree
  #USER: inventree
  #PASSWORD: inventree_password
  #HOST: 'localhost'
  #PORT: '5432'

  # --- Example Configuration - sqlite3 ---
  # ENGINE: sqlite3
  # NAME: '/home/inventree/database.sqlite3'

# Set debug to False to run in production mode
# Use the environment variable INVENTREE_DEBUG
debug: False

# Configure the system logging level
# Use environment variable INVENTREE_LOG_LEVEL
# Options: DEBUG / INFO / WARNING / ERROR / CRITICAL
log_level: WARNING

# Select default system language (default is 'en-us')
# Use the environment variable INVENTREE_LANGUAGE
language: en-us

# System time-zone (default is UTC)
# Reference: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
timezone: UTC

# Base URL for the InvenTree server
# Use the environment variable INVENTREE_BASE_URL
# base_url: 'http://localhost:8000'

# Base currency code (or use env var INVENTREE_BASE_CURRENCY)
base_currency: USD

# Add new user on first startup
#admin_user: admin
#admin_email: [email protected]
#admin_password: inventree

# List of currencies supported by default. Add other currencies here to allow use in InvenTree
currencies:
  - AUD
  - CAD
  - CNY
  - EUR
  - GBP
  - JPY
  - NZD
  - USD

# Email backend configuration
# Ref: https://docs.djangoproject.com/en/dev/topics/email/
# Alternatively, these options can all be set using environment variables,
# with the INVENTREE_EMAIL_ prefix:
# e.g. INVENTREE_EMAIL_HOST / INVENTREE_EMAIL_PORT / INVENTREE_EMAIL_USERNAME
# Refer to the InvenTree documentation for more information

email:
  # backend: 'django.core.mail.backends.smtp.EmailBackend'
  host: ''
  port: 25
  username: ''
  password: ''
  sender: ''
  tls: False
  ssl: False

# Set sentry_enabled to True to report errors back to the maintainers
# Set sentry,dsn to your custom DSN if you want to use your own instance for error reporting
sentry_enabled: False
#sentry_sample_rate: 0.1
#sentry_dsn: https://[email protected]/custom

# Set this variable to True to enable InvenTree Plugins
# Alternatively, use the environment variable INVENTREE_PLUGINS_ENABLED
plugins_enabled: true
plugin_file: '/etc/inventree/plugins.txt'
#plugin_dir: '/path/to/plugins/'

# Set this variable to True to enable auto-migrations
# Alternatively, use the environment variable INVENTREE_AUTO_UPDATE
auto_update: False

# Allowed hosts (see ALLOWED_HOSTS in Django settings documentation)
# A list of strings representing the host/domain names that this Django site can serve.
# Default behaviour is to allow all hosts (THIS IS NOT SECURE!)
allowed_hosts:
  - '*'

# Cross Origin Resource Sharing (CORS) settings (see https://github.com/ottoyiu/django-cors-headers)
# Following parameters are
cors:
  # CORS_ORIGIN_ALLOW_ALL - If True, the whitelist will not be used and all origins will be accepted.
  allow_all: True

  # CORS_ORIGIN_WHITELIST - A list of origins that are authorized to make cross-site HTTP requests. Defaults to []
  # whitelist:
  # - https://example.com
  # - https://sub.example.com

# MEDIA_ROOT is the local filesystem location for storing uploaded files
media_root: '/opt/inventree/data/media'

# STATIC_ROOT is the local filesystem location for storing static files
static_root: '/opt/inventree/data/static'

### Backup configuration options ###
# INVENTREE_BACKUP_DIR is the local filesystem location for storing backups
backup_storage: django.core.files.storage.FileSystemStorage
backup_dir: '/opt/inventree/data/backup'
#backup_options:

# Background worker options
background:
  workers: 4
  timeout: 90
  max_attempts: 5

# Optional URL schemes to allow in URL fields
# By default, only the following schemes are allowed: ['http', 'https', 'ftp', 'ftps']
# Uncomment the lines below to allow extra schemes
#extra_url_schemes:
#  - mailto
#  - git
#  - ssh

# Login configuration
login_confirm_days: 3
login_attempts: 5
login_default_protocol: http

# Remote / proxy login
# These settings can introduce security problems if configured incorrectly. Please read
# https://docs.djangoproject.com/en/4.0/howto/auth-remote-user/ for more details
# The header name should be prefixed by `HTTP`. Please read the docs for more details
# https://docs.djangoproject.com/en/stable/ref/request-response/#django.http.HttpRequest.META
remote_login_enabled: False
remote_login_header: HTTP_REMOTE_USER

# JWT tokens
# JWT can be used optionally to authenticate users. Turned off by default.
# Alternatively, use the environment variable INVENTREE_USE_JWT
# use_jwt: True

# Logout redirect configuration
# This setting may be required if using remote / proxy login to redirect requests
# during the logout process (default is 'index'). Please read the docs for more details
# https://docs.djangoproject.com/en/stable/ref/settings/#logout-redirect-url
#logout_redirect_url: 'index'

# Permit custom authentication backends
#authentication_backends:
#  - 'django.contrib.auth.backends.ModelBackend'

#  Custom middleware, sometimes needed alongside an authentication backend change.
#middleware:
#  - 'django.middleware.security.SecurityMiddleware'
#  - 'django.contrib.sessions.middleware.SessionMiddleware'
#  - 'django.middleware.locale.LocaleMiddleware'
#  - 'django.middleware.common.CommonMiddleware'
#  - 'django.middleware.csrf.CsrfViewMiddleware'
#  - 'corsheaders.middleware.CorsMiddleware'
#  - 'django.contrib.auth.middleware.AuthenticationMiddleware'
#  - 'django.contrib.messages.middleware.MessageMiddleware'
#  - 'django.middleware.clickjacking.XFrameOptionsMiddleware'
#  - 'InvenTree.middleware.AuthRequiredMiddleware'

# Add SSO login-backends (see examples below)
# social_backends:
#  - 'allauth.socialaccount.providers.google'
#  - 'allauth.socialaccount.providers.github'
#  - 'allauth.socialaccount.providers.keycloak'

# Add specific settings for social account providers (if required)
# social_providers:
#   keycloak:
#     KEYCLOAK_URL: 'https://keycloak.custom/auth'
#     KEYCLOAK_REALM: 'master'

# Customization options
# Add custom messages to the login page or main interface navbar or exchange the logo
# Use environment variable INVENTREE_CUSTOMIZE or INVENTREE_CUSTOM_LOGO
# customize:
#   login_message: InvenTree demo instance - <a href='https://docs.inventree.org/en/latest/demo/'> Click here for login details</a>
#   navbar_message: <h6>InvenTree demo mode <a href='https://docs.inventree.org/en/latest/demo/'><span class='fas fa-info-circle'></span></a></h6>
#   logo: logo.png
#   splash: splash_screen.jpg
#   hide_admin_link: true
#   hide_password_reset: true

# Custom flags
# InvenTree uses django-flags; read more in their docs at https://cfpb.github.io/django-flags/conditions/
# Use environment variable INVENTREE_FLAGS or the settings below
# flags:
#  MY_FLAG:
#     - condition: 'parameter'
#       value: 'my_flag_param1'

[imager2019]

@SchrodingersGat - just checking to see if you had any additional thoughts? To me, the config.yaml file looks okay - but I could be wrong.

I also went ahead and performed a config variable dump, and this is what I have:

(env) inventree@debian:/opt/inventree$ inventree config
APP_GROUP=inventree
APP_HOME=/opt/inventree
APP_NAME=inventree
APP_RUNNER_CLI=systemctl
APP_RUNNER_TYPE=systemd
APP_SAFE_NAME=inventree
APP_USER=inventree
APP_WIZARDS=
FORWARDED_ALLOW_IPS=*
GUNICORN_CMD_ARGS=--access-logfile -
HOME=/home/inventree
INVENTREE_CONFIG_FILE=/etc/inventree/config.yaml
LANG=en_US.UTF-8
OLDPWD=/opt/inventree
ORIGINAL_PWD=/opt/inventree
PATH=/opt/inventree/.heroku/python/bin:/usr/local/bin:/usr/local/sbin:/usr/bin:/usr/sbin:/bin:/sbin:.:/usr/sbin
PORT=6000
PWD=/opt/inventree
PYTHONHASHSEED=random
PYTHONPATH=/opt/inventree
PYTHONUNBUFFERED=true
ROOT_PATH=/
SHLVL=0

Does anything look wrong? Would it be best if I opened a problem ticket?

John

[SchrodingersGat]

Ah, ok I think that for the installer, you don't use invoke directly - you need to use the inventree-cli command - right @matmair ?

Do we detail this properly in the docs? I found this:

[imager2019]

I do recall seeing mention of inventree-cli somewhere in the past but I cannot find any other notes on it.

Is the command I need to run inventree-cli backup or inventre-cli restore ? If so, what path should these be executed from?

[imager2019]

@SchrodingersGat / @matmair .
I have executed the inventree run cli from my /etc/ path and it executes without error (no error, nor any confirmation).

How would I execute the restore or backup using this? Would the command be inventree run cli restore ? When I try this, I do not receive/see any response or errors.

John

[imager2019]

@SchrodingersGat / @matmair
Any updates? Have not been able to execute the backup or restore as of yet.
Thoughts??

[SchrodingersGat]

@imager2019 ok, it has taken me a while to get down to the bottom of this but I think I have pieced it all together now.

If you are still interested, can you please run the following test to see if it fixes the issue on your end.

cd /opt/inventree/vendor/pkgr/processes
nano cli

Then, edit the second line of that file to be as follows:

.  ./env/bin/activate && exec env/bin/python -m invoke $@

Next, run inventree run cli version - you should see version information like follows:

InvenTree - inventree.org
The Open-Source Inventory Management System


Installation paths:
Base        /opt/inventree
Config      /etc/inventree/config.yaml
Media       /opt/inventree/data/media
Static      /opt/inventree/data/static

Versions:
Python      3.8.10
Django      3.2.19
InvenTree   0.12.8
API         127

Commit hash:None
Commit date:None