maddiethegm/Home-Inventory
1
0
Fork 0
mirror of https://github.com/maddiethegm/Home-Inventory.git synced 2026-02-22 10:14:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated main readme and controller & viewer readmes with deployment instructions.

Browse Source
This commit is contained in:
maddiethegm
2026-02-11 01:08:14 -05:00
parent 0b7e64d317
commit d8addea4dd
3 changed files with 26 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Home-Inventory-Controller

Submodule Home-Inventory-Controller updated: dcb543bbc4...415bf00662

2
Home-Inventory-Viewer

Submodule Home-Inventory-Viewer updated: 4addd23af3...09aa212819

25
README.md
View File

@@ -1,16 +1,27 @@
# Home-Inventory # Home-Inventory
Home Inventory provides a complete inventory management system in a modular format. The provided architecture for Home Inventory is:
- Home Inventory Controller
The Controller manages data stored in a SQL server (MS SQL or MariaDB/MySQL) and user authentication via LDAP, making these available to the client through a REST API. The submodule contains instructions for deployment using [PM2-installer](https://github.com/jessety/pm2-installer).
- Home Inventory Viewer
The viewer displays data from and allows interaction with the Controller. Notably, the Controller does not share assets with the Viewer- assets are instead loaded from external URLs provided by the controller. The submodule contains deployment instructions.
## Config ## Config
### API Server Configuration
#### Save these variables in /.env ### Save these variables in /.env
The following environment variables are used to configure the application: The following environment variables are used to configure the application:
> PORT= > PORT=
API server listening port. API server listening port.
Default: 3001 Default: 3001
### DB Config ### DB Config
> DB_USER= > DB_USER=
DB username for read/write access DB username for read/write access
@@ -28,7 +39,9 @@ The following environment variables are used to configure the application:
> DB_TYPE= > DB_TYPE=
Options: mssql, oracle, mariadb, postgres Options: mssql, oracle, mariadb, postgres
### JWT Configuration ### JWT Configuration
> JWT_SECRET= > JWT_SECRET=
Example: your_secret_key Example: your_secret_key
@@ -36,7 +49,9 @@ The following environment variables are used to configure the application:
Example: '8h' Example: '8h'
Default: '1h' Default: '1h'
### LDAP Config ### LDAP Config
> LDAP_URL= > LDAP_URL=
Example: ldap://example.tld Example: ldap://example.tld
@@ -46,14 +61,20 @@ The following environment variables are used to configure the application:
> LDAP_USER_ATTRIBUTE= > LDAP_USER_ATTRIBUTE=
Example: 'cn' Example: 'cn'
### React App Config ### React App Config
Save these variables client folder - default /client/.env Save these variables client folder - default /client/.env
### API Config ### API Config
> REACT_APP_API_URL= > REACT_APP_API_URL=
URL to reach your API backend. This is relative to your client, not the frontend server. URL to reach your API backend. This is relative to your client, not the frontend server.
Example: http://homeinv.example.tld/api:3001 Example: http://homeinv.example.tld/api:3001
### Footer details ### Footer details
> REACT_APP_SUPPORT_CONTACT= > REACT_APP_SUPPORT_CONTACT=
Example: "Me" Example: "Me"