diff --git a/Home-Inventory-Controller b/Home-Inventory-Controller index dcb543b..415bf00 160000 --- a/Home-Inventory-Controller +++ b/Home-Inventory-Controller @@ -1 +1 @@ -Subproject commit dcb543bbc48dcab87e4e27b649d3a53fb57fbf22 +Subproject commit 415bf00662de12ed6f7f241288ee0feb1f4af37b diff --git a/Home-Inventory-Viewer b/Home-Inventory-Viewer index 4addd23..09aa212 160000 --- a/Home-Inventory-Viewer +++ b/Home-Inventory-Viewer @@ -1 +1 @@ -Subproject commit 4addd23af365fff0220ac2fc4dac26cdaf776776 +Subproject commit 09aa212819793af180ccb0933e34488894e2e041 diff --git a/README.md b/README.md index 4765e8d..28c3ae9 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,27 @@ # 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 -### API Server Configuration -#### Save these variables in /.env + +### Save these variables in /.env + The following environment variables are used to configure the application: > PORT= API server listening port. Default: 3001 + ### DB Config + > DB_USER= DB username for read/write access @@ -28,7 +39,9 @@ The following environment variables are used to configure the application: > DB_TYPE= Options: mssql, oracle, mariadb, postgres + ### JWT Configuration + > JWT_SECRET= Example: your_secret_key @@ -36,7 +49,9 @@ The following environment variables are used to configure the application: Example: '8h' Default: '1h' + ### LDAP Config + > LDAP_URL= Example: ldap://example.tld @@ -46,16 +61,22 @@ The following environment variables are used to configure the application: > LDAP_USER_ATTRIBUTE= Example: 'cn' + ### React App Config + Save these variables client folder - default /client/.env + ### API Config + > REACT_APP_API_URL= URL to reach your API backend. This is relative to your client, not the frontend server. Example: http://homeinv.example.tld/api:3001 + ### Footer details + > REACT_APP_SUPPORT_CONTACT= - + Example: "Me" Example: "admin@example.tld" > REACT_APP_FOOTER_IMG_URL=