Daniele Bonini (皮夕): WebDev, DevOps and project care by lots of Simplicity bits 4 rokov pred
rodič
commit
863daa2b86
1 zmenil súbory, kde vykonal 22 pridanie a 1 odobranie
  1. 22 1
      README.md

+ 22 - 1
README.md

@@ -1,2 +1,23 @@
 # Invenktory
-Finally the smart way to track your hardware or any other geek stuff (on premise solution) - GPL License
+Hello and welcome to Invenktory!   
+   
+Invenktory is a light and simple software on premise to track your devices.     
+   
+Invenktory is released under GPLv3 license, it is supplied AS-IS and we do not take any responsibility for its misusage.    
+   
+First step, use the left side panel password and salt fields to create the hash to insert in the config file. Remember to manually set there also the salt value.   
+   
+As you are going to run Invenktory in the PHP process context, using a limited web server or phpfpm user, you must follow some simple directives for an optimal first setup:
+
+1. Check the permissions of your "Inventory" folder in your web app private path; and set its path in the config file.   
+2. In the Inventory path create a ".INVsampledir" folder and give to this folder the write permission. This folder will be the sample folder to copy from new folders inside the inventory path.   
+3. Likewise, in the Inventory path must exist ".INVsamplefile.xml" and give to this file the write permission. This file will be the sample file to copy from new inventory files.   
+4. Configure the max devices per xml file as required (default: 10).   
+5. Configure the max history items and max recall history items as required (default: 50).  
+  
+Http Console understands a limited set of commands with a far limited set of parameters:  
+cd, cd.., cp, edit, help, ls, mv, pwd, show  	   
+
+In edit mode press [CTRL]+[X] to exit or [CTRL]+[S] to save.   
+   
+Hope you can enjoy it and let us know about any feedback: info@invenktory.com