Change to mkdocs documentation

This commit is contained in:
2019-11-19 09:38:03 +01:00
parent cbe562da96
commit 99a0d5f484
14 changed files with 97 additions and 70 deletions

25
docs/file_hierarchy.md Normal file
View File

@@ -0,0 +1,25 @@
# File hierarchy
## Root folder
- api.py -> Server file. It manages all requests from clients and connects to database
- loadserver.bat -> A helper to run api.py on Windows
- sql.py -> Helper for api.py sql sentences
- sysopt.py -> Config of api and sql
## Client folder
- client.ps1 -> This file has to run every X time (I suggest every hour) on every client and as NT\SYSTEM or local admin. You can do this with a Task Schedule as SYSTEM in a GPO (Active Directory)
- control.pyw -> This is the gui of the program. With that you manages the client-server program. It has to be in same folder as configpcm.ini file
- configpcm.ini -> Configuration for client and control.
## BD folder
- database.db -> Database file in sqlite3
## cooks folder
It has the cooks in yaml format.
Warning: Do not change name of cooks created and assigned directly.
## Doc folder
Documentation...
## REPO folder (This isn't needeed to be there)
You have to have this shared on LAN, this is the folder that cooks use to retrieve your files (As .exe/.msi) to use in scripts.