From 89cdbf3003ddddd4af1a526cfd1973bfb65050af Mon Sep 17 00:00:00 2001
From: Holger Sielaff <sielaff@email.de>
Date: Wed, 27 Aug 2025 10:01:13 +0200
Subject: [PATCH] Added README and ignorefile

---
 .gitignore |  9 +++++++++
 README.md  | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 58 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..69afb47
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,9 @@
+/.*
+/*.md
+/*.sqlite3
+/venv
+__pycache__
+*.swp
+*.pyc
+!/.gitignore
+!/README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8d8385d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,49 @@
+# Django Proxmox/Mikrotik
+
+A django app that provides a development env on a proxmox with DNS etc via Mikrotik
+
+
+## `.env`
+you need an `.env` File with the following params:
+
+```dotenv
+ALLOWED_HOSTS="127.0.0.1,localhost"
+
+PROXMOX_HOST=""
+PROXMOX_USER=""
+PROXMOX_PASS=""
+PROXMOX_NODE=""
+PROXMOX_READONLY=0
+PROXMOX_MAX_MEM=8092
+PROXMOX_MAX_DISK=100
+PROXMOX_MAX_CORES=8
+PROXMOX_CREATE_LXC_TIMEOUT=600
+
+
+MIKROTIK_HOST=""
+MIKROTIK_USER=""
+MIKROTIK_PASS=""
+MIKROTIK_IP_8=""
+MIKROTIK_READONLY=0
+
+DATABASE_ENGINE=""
+DATABASE_USER=""
+DATABASE_PASSWORD=""
+DATABASE_HOST=""
+DATABASE_PORT=5432
+DATABASE_USER=""
+DATABASE_NAME=""
+
+AUTH_LDAP_HOST=""
+AUTH_LDAP_BIND_DN=""
+AUTH_LDAP_BIND_PASSWORD=""
+AUTH_LDAP_USER_BASE=""
+AUTH_LDAP_USER_FILTER=""
+AUTH_LDAP_GROUP_SEARCH_BASE=""
+AUTH_LDAP_GROUP_SEARCH_FILTER=""
+AUTH_LDAP_USER_ATTR_MAP='{"first_name": "givenName", "last_name": "sn", "email": "mail", "username": "uid"}'
+AUTH_LDAP_USER_FLAGS_BY_GROUP='{ "is_staff": "cn=staff,ou=groups,...", "is_superuser": "cn=root,ou=groups,..."}'
+AUTH_LDAP_FIND_GROUP_PERMS=1
+AUTH_LDAP_CACHE_GROUPS=1
+AUTH_LDAP_GROUP_CACHE_TIMEOUT=3600
+```
\ No newline at end of file