2
0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-04-28 13:46:54 +00:00

Change "invoke" -> "inv"

This commit is contained in:
Oliver Walters 2020-11-24 21:26:40 +11:00
parent 9b5c8a2974
commit a0c91203b0
5 changed files with 17 additions and 17 deletions

View File

@ -40,7 +40,7 @@ MySQL database backend is supported with the native Django implemetation. To run
To install these required packages, run the following command: To install these required packages, run the following command:
``` ```
invoke mysql inv mysql
``` ```
It is then up to the database adminstrator to create a new MySQL database to store inventree data, in addition to a username/password to access the data. It is then up to the database adminstrator to create a new MySQL database to store inventree data, in addition to a username/password to access the data.
@ -61,7 +61,7 @@ PostgreSQL database backend is supported with the native Django implementation.
To install these required packages, run the following commands: To install these required packages, run the following commands:
``` ```
invoke postgresql inv postgresql
``` ```
It is then up to the database adminstrator to create a new PostgreSQL database to store inventree data, in addition to a username/password to access the data. It is then up to the database adminstrator to create a new PostgreSQL database to store inventree data, in addition to a username/password to access the data.

View File

@ -19,7 +19,7 @@ The InvenTree development server is useful for testing and configuration - and i
To run the development server on a local machine, run the command: To run the development server on a local machine, run the command:
``` ```
invoke server -a 127.0.0.1:8000 inv server -a 127.0.0.1:8000
``` ```
Serving on the address `127.0.0.1` means that InvenTree will only be available *on that computer*. The server will be accessible from a web browser on the same computer, but not from any other computers on the local network. Serving on the address `127.0.0.1` means that InvenTree will only be available *on that computer*. The server will be accessible from a web browser on the same computer, but not from any other computers on the local network.
@ -29,7 +29,7 @@ Serving on the address `127.0.0.1` means that InvenTree will only be available *
To enable access to the InvenTree server from other computers on a local network, you need to know the IP of the computer running the server. For example, if the server IP address is `192.168.120.1`: To enable access to the InvenTree server from other computers on a local network, you need to know the IP of the computer running the server. For example, if the server IP address is `192.168.120.1`:
``` ```
invoke server -a 192.168.120.1:8000 inv server -a 192.168.120.1:8000
``` ```
!!! warning "Not For Production" !!! warning "Not For Production"
@ -59,7 +59,7 @@ Directories for storing *media* files and *static* files should be specified in
The required static files must be collected into the specified ``STATIC_ROOT`` directory: The required static files must be collected into the specified ``STATIC_ROOT`` directory:
``` ```
invoke static inv static
``` ```
This command collects all of the required static files (including script and css files) into the specified directory ready to be served. This command collects all of the required static files (including script and css files) into the specified directory ready to be served.

View File

@ -111,7 +111,7 @@ pip3 install invoke
To display a list of the available configuration scripts, run the following command: To display a list of the available configuration scripts, run the following command:
``` ```
invoke --list inv --list
``` ```
## Download Source Code ## Download Source Code
@ -140,7 +140,7 @@ Now that the source code is downloaded (and optionally you have configured a Pyt
To setup the InvenTree environment, run the following commands (from the InvenTree source directory): To setup the InvenTree environment, run the following commands (from the InvenTree source directory):
``` ```
invoke install inv install
``` ```
This installs all required Python packages using pip package manager. It also creates a (default) database configuration file which needs to be edited to meet user needs before proceeding (see next step below). This installs all required Python packages using pip package manager. It also creates a (default) database configuration file which needs to be edited to meet user needs before proceeding (see next step below).
@ -166,7 +166,7 @@ For further information on installation configuration, refer to the [Configurati
Once install settings are correctly configured (in *config.yaml*) run the initial setup script: Once install settings are correctly configured (in *config.yaml*) run the initial setup script:
``` ```
invoke migrate inv migrate
``` ```
This performs the initial database migrations, creating the required tables, etc. This performs the initial database migrations, creating the required tables, etc.
@ -178,11 +178,11 @@ The database should now be installed!
Create an initial superuser (administrator) account for the InvenTree instance: Create an initial superuser (administrator) account for the InvenTree instance:
``` ```
invoke superuser inv superuser
``` ```
!!! warning "Solving Cairo Errors" !!! warning "Solving Cairo Errors"
In the case the above command returns errors with the `Cairo` package, it implies that dependencies for the `weasyprint` package are not installed on the system. To solve them, run through the [weasyprint installation steps](https://weasyprint.readthedocs.io/en/stable/install.html) then re-run `invoke install` and `invoke superuser`. In the case the above command returns errors with the `Cairo` package, it implies that dependencies for the `weasyprint` package are not installed on the system. To solve them, run through the [weasyprint installation steps](https://weasyprint.readthedocs.io/en/stable/install.html) then re-run `inv install` and `inv superuser`.
### Run Development Server ### Run Development Server
@ -191,13 +191,13 @@ The InvenTree database is now setup and ready to run. A simple development serve
To launch the development server, run the following commands: To launch the development server, run the following commands:
``` ```
invoke server inv server
``` ```
For more server options, run: For more server options, run:
``` ```
invoke server -h inv server -h
``` ```
This will launch the InvenTree web interface at `http://127.0.0.1:8000`. For other options refer to the [django docs](https://docs.djangoproject.com/en/2.2/ref/django-admin/) This will launch the InvenTree web interface at `http://127.0.0.1:8000`. For other options refer to the [django docs](https://docs.djangoproject.com/en/2.2/ref/django-admin/)

View File

@ -12,14 +12,14 @@ For example, if you wish to migrate from an SQLite database backend to a MySQL d
Ensure that the original database is securely backed up first! Ensure that the original database is securely backed up first!
!!! info "Up to Date" !!! info "Up to Date"
Ensure that the original database is up to date, by running `invoke migrate` Ensure that the original database is up to date, by running `inv migrate`
### Export Data ### Export Data
Export the database contents to a JSON file using the following command: Export the database contents to a JSON file using the following command:
``` ```
invoke export-records -f data.json inv export-records -f data.json
``` ```
This will create JSON file at the specified location which contains all database records. This will create JSON file at the specified location which contains all database records.
@ -34,7 +34,7 @@ Configure the new database using the normal processes (see [Configuration](../co
Then, ensure that the database schema are correctly initialized in the new database: Then, ensure that the database schema are correctly initialized in the new database:
``` ```
invoke migrate inv migrate
``` ```
This ensures that the required database tables exist, which must be the case before data can be imported. This ensures that the required database tables exist, which must be the case before data can be imported.
@ -44,7 +44,7 @@ This ensures that the required database tables exist, which must be the case bef
The new database should now be correctly initialized with the correct table structures requried to import the data. Run the following command to load the databased dump file into the new database. The new database should now be correctly initialized with the correct table structures requried to import the data. Run the following command to load the databased dump file into the new database.
``` ```
invoke import-records -f data.json inv import-records -f data.json
``` ```
!!! info "Import Filename" !!! info "Import Filename"

View File

@ -28,7 +28,7 @@ git pull origin master
Updating the database is as simple as calling the `update` script: Updating the database is as simple as calling the `update` script:
``` ```
invoke update inv update
``` ```
This command performs the following steps: This command performs the following steps: