From 2e9632df774e0ad65432d30c6122ccd3f2553f23 Mon Sep 17 00:00:00 2001 From: Collin Date: Thu, 14 Mar 2024 14:54:25 +0000 Subject: [PATCH] Install.md --- .vitepress/config.ts | 9 ++++---- guide/install.md | 40 +++++++++++++++++++++++++++++++++ {client => guide}/javascript.md | 0 {client => guide}/php.md | 0 {client => guide}/python.md | 0 5 files changed, 44 insertions(+), 5 deletions(-) create mode 100644 guide/install.md rename {client => guide}/javascript.md (100%) rename {client => guide}/php.md (100%) rename {client => guide}/python.md (100%) diff --git a/.vitepress/config.ts b/.vitepress/config.ts index cbff498..b2f96bb 100644 --- a/.vitepress/config.ts +++ b/.vitepress/config.ts @@ -41,16 +41,15 @@ export default defineConfig({ { text: 'Getting Started', link: '/guide/getting-started' }, { text: 'Installation', link: '/guide/install' }, { text: 'Webinterface', link: '/guide/webinterface' }, - { text: 'Clients', link: '/guide/clients' }, - { text: 'Plugins', link: '/guide/plugins' } + { text: 'Clients', link: '/guide/clients' } ] }, { text: 'Clients', items: [ - { text: 'PHP', link: '/client/php' }, - { text: 'JavaScript', link: '/client/javascript' }, - { text: 'Python', link: '/client/python' } + { text: 'PHP', link: '/guide/php' }, + { text: 'JavaScript', link: '/guide/javascript' }, + { text: 'Python', link: '/guide/python' } ] } ], diff --git a/guide/install.md b/guide/install.md new file mode 100644 index 0000000..eb199fa --- /dev/null +++ b/guide/install.md @@ -0,0 +1,40 @@ +# Prerequisites +Make sure you have curl installed.
+If not: +```bash +sudo apt-get install curl +``` + +# Installation + +## 1. Run the install script with sudo: + +```bash +sudo curl -fsSL https://lona-development.org/download/install.sh | sh +``` + +## 2. Start the Server: + +```bash +./start.sh +``` + +## 3. Configure everything: + +On every start, you have to put in your encryption key. +If the wrong key has been provided, the configuration file cannot be read and the Server will stop instantly. + +If wanted, you can change the ```php ...``` line in the start.sh file to automatically put in your encryption key: +```bash +printf "yourEncryptionKey\n" | php ... +``` +But this is not recommended since it will basically make everyone be able to find your root user password, wich is stored in the config file, which is encrypted with this key. + +We don't store the key by default because of security of the root user. + +If you don't have a configuration file, a users table or any data tables, the Server will run you through initial setup and create everything needed for the database to run. + +## 4. Use your database: + +Thats it! +You have your own instance of LonaDB! \ No newline at end of file diff --git a/client/javascript.md b/guide/javascript.md similarity index 100% rename from client/javascript.md rename to guide/javascript.md diff --git a/client/php.md b/guide/php.md similarity index 100% rename from client/php.md rename to guide/php.md diff --git a/client/python.md b/guide/python.md similarity index 100% rename from client/python.md rename to guide/python.md