mirror of
https://github.com/inventree/InvenTree.git
synced 2026-01-11 21:57:57 +00:00
11ab0203b1
* Add builtin plugin for auto-issuing orders * Add plugin to auto-issue orders * Add placeholder documentation * Fix typo * Adds image macro - To replace img.html - includes checking if file exists * Fix tooltips * More docs * Adjust plugin settings filters * docs * More docs * More docs * Updates * Less restrictive URL checking * Refactor build order page * Fix typo * Allow 429 * Debug output * More debug * Construct assets dir * Cleanup * Update docs README * Refactoring more pages * Fix image link * Fix SSO settings * Add hook to check for missing settings - Ensure that all settings are documented! * Add missing user settings * Update docstring * Tweak SSO.md * Image updates * More updates * Tweaks * Exclude orders without a target_date * Fix for issuing build orders * Further refactoring * Fixes * Image refactoring * More refactoring * More refactoring * Refactor app images * Fix pathing issues * Suppress some openapidocs warnings in logs (much easier to debug docs build issues) * Fix image reference * Reduce error messages * Fix image links * Fix image links * Reduce docs log output * Ensure settings are loaded before displaying them * Fix for UI test * Fix unit test * Test tweaks
56 lines
2.5 KiB
Markdown
56 lines
2.5 KiB
Markdown
---
|
|
title: Connect to Server
|
|
---
|
|
|
|
## Connect to InvenTree
|
|
|
|
Use of the InvenTree app assumes that you (the user) have access to an InvenTree server.
|
|
|
|
When first running the app, no profile has been configured. The *server* icon in the top-right corner of the home screen is <span style='color: red'>red</span>, indicating that there is no connection to an InvenTree server:
|
|
|
|
{{ image("app/initial.png", "No server configured") }}
|
|
|
|
Press on the server icon to navigate to the server selection view:
|
|
|
|
{{ image("app/no_profiles.png", "No server configured") }}
|
|
|
|
### Create Server
|
|
|
|
!!! success "Server Profiles"
|
|
The app supports multiple server profiles, providing simple switching between different InvenTree servers and/or account profiles.
|
|
|
|
Press the {{ icon("circle-plus", color="blue") }} button in the bottom-right corner of the screen to create a new server profile.
|
|
|
|
{{ image("app/add_server_profile.png", "Add server profile") }}
|
|
|
|
Enter the required server details:
|
|
|
|
| Parameter | Description |
|
|
| --- | --- |
|
|
| **Name** | Name for the server profile (can be any value, simply for reference) |
|
|
| **Server** | InvenTree server address (including port, if required). e.g. `http://inventree.myserver.com:8080` |
|
|
| **Username** | Your account username (case sensitive) |
|
|
| **Password** | Your account password (case sensitive) |
|
|
|
|
### Connect to Server
|
|
|
|
Once the server profile is created, you need to connect to the server. Simply short press on the server profile to connect.
|
|
|
|
Alternatively, long press on the server profile to activate the context menu, then select *Connect to Server*.
|
|
|
|
When the app successfully connects to the server, a success message is briefly displayed at the bottom of the screen. A green {{ icon("circle-check", color="green") }} icon next to the server profile indicate that the profile is currently *selected* and also the connection was successful.
|
|
|
|
{{ image("app/connected.png", "Connected to server") }}
|
|
|
|
### Connection Failure
|
|
|
|
If (for whatever reason) the app does not successfully connect to the InvenTree server, a failure message is displayed, and a red {{ icon("circle-x", color="red") }} icon is displayed next to the server profile.
|
|
|
|
{{ image("app/unauthorized.png", "Connection failure") }}
|
|
|
|
In this case, the error message displayed at the bottom of the screen provides context as to why the app could not successfully connect to the server.
|
|
|
|
To edit the server profile details, long press on the server profile, and select *Edit Server Profile*:
|
|
|
|
{{ image("app/edit_server.png", "Edit server profile") }}
|