Feature/bare metal install improvements#11049
Open
CapnKernel wants to merge 8 commits into
Open
Conversation
Still needs testing and refinement
✅ Deploy Preview for inventree-web-pui-preview canceled.
|
Contributor
Author
|
Seems the doc build check has failed. I put a possible web address of Suggestions? |
SchrodingersGat
added
setup
matmair
reviewed
Dec 21, 2025
Comment on lines
+124
to
+136
| Several more options need settings, but these depend on your particular installation. Here is an example configuration for a site running at `https://itree.example.com/`, using a MariaDB database backend. Choose values suitable for your installation. | ||
|
|
||
| ``` | ||
| pip install --upgrade --ignore-installed invoke | ||
| ``` | ||
| | Option name | Value | Notes | | ||
| |-------------|-------|-------| | ||
| | `site_url` | `https://itree.example.com/` | Use http://localhost:8000 for local testing. | | ||
| | `database` » `ENGINE`<br>`database` » `NAME`<br>`database` » `USER`<br>`database` » `PASSWORD` | `mysql`<br>`inventree`<br>`dbuser`<br>`VeryC0mPLekSP4SS` | For configuring other databases, see [Database configuration for Django](https://docs.djangoproject.com/en/5.2/ref/databases/). Database creation is covered below.| | ||
| | `admin_url` | `itree-admin` | Moves admin interface to `https://itree.example.com/itree-admin/`, to reduce scripted attacks. | | ||
| | `admin_email` | `itree-admin@example.com` | Who puzzled users should email. | ||
| | `admin_password` | `^TotalllllyUnge55ible` | Password for the admin user. | | ||
| | `language` | `en-US` | See this list of [language codes](http://www.i18nguy.com/unicode/language-identifiers.html). | | ||
| | `timezone` | `Australia/Hobart` | See this list of [timezone names](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). | | ||
| | `email` » `sender`<br>`email` » `host`<br>`email` » `port`<br>`email` » `username`<br>`email` » `password` | `itree@example.com`<br>`mail.unst0ppable-email.com`<br>`2525`<br>`itree`<br>`tHE_n4emOfMyCAT` | Credentials and connection details for your favorite email sending company. See [Django email settings](https://docs.djangoproject.com/en/5.2/ref/settings/#email-backend). | | ||
| | `global_settings` » `INVENTREE_DEFAULT_CURRENCY` | `USD` | See this list of [currency codes](https://en.wikipedia.org/wiki/ISO_4217). | |
Member
There was a problem hiding this comment.
I do not agree with providing a static sample config; this would have to be upkept regularly when mechanisms change - we already have a problem with docs drift.
Are you committed to keep this section up to date? If not, I would like this removed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hi @SchrodingersGat,
In #10829 you encouraged me to keep going with my rewrite of the bare metal install instructions. Well I'm back with a new installment. It's now close to being done but needs some further refinement and testing.
This is not ready for committing to master yet, but could be put on a branch
I think the diff compared to master won't be useful reading. I suggest either reviewing the second commit, or reading the rendered read the docs version.
I look forward to your feedback.