mirror of
https://github.com/maddiethegm/Home-Inventory.git
synced 2026-02-22 10:14:27 +00:00
83 lines
1.9 KiB
Markdown
83 lines
1.9 KiB
Markdown
# 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
|
|
|
|
### 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
|
|
> DB_PASSWORD=
|
|
|
|
Password to login as DB_USER
|
|
> DB_SERVER=
|
|
|
|
DB server URL
|
|
Example: sql.example.tld
|
|
Example: localhost
|
|
> DB_DATABASE=
|
|
|
|
Your database name
|
|
> DB_TYPE=
|
|
|
|
Options: mssql, oracle, mariadb, postgres
|
|
|
|
### JWT Configuration
|
|
|
|
> JWT_SECRET=
|
|
|
|
Example: your_secret_key
|
|
> TOKEN_EXPIRY=
|
|
|
|
Example: '8h'
|
|
Default: '1h'
|
|
|
|
### LDAP Config
|
|
|
|
> LDAP_URL=
|
|
|
|
Example: ldap://example.tld
|
|
> LDAP_DOMAIN_COMPONENTS=
|
|
|
|
Example: 'cn=users,dc=example,dc=tld'
|
|
> 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=
|