From 719e97815c8fdbb3348d1f16196f7bd02a287c8d Mon Sep 17 00:00:00 2001 From: Collin Date: Fri, 2 Feb 2024 14:38:22 +0000 Subject: [PATCH] Update docs --- .vitepress/config.ts | 24 ++++++++---------------- guide/deploy.md | 0 guide/getting-started.md | 31 +++++++++++++++---------------- index.md | 10 +++++----- 4 files changed, 28 insertions(+), 37 deletions(-) delete mode 100644 guide/deploy.md diff --git a/.vitepress/config.ts b/.vitepress/config.ts index 168dd08..f98f0f8 100644 --- a/.vitepress/config.ts +++ b/.vitepress/config.ts @@ -2,7 +2,7 @@ import { defineConfig } from 'vitepress' const ogUrl = 'https://lona.js.org/' const ogImage = `${ogUrl}og.png#1` -const title = 'LonaDB' +const title = 'Lona Development' const description = 'JSON based Database written in JavaScript' // https://vitepress.dev/reference/site-config @@ -10,7 +10,7 @@ export default defineConfig({ head: [ ['link', { rel: 'icon', href: '/favicon.svg', type: 'image/svg+xml' }], ['meta', { name: 'theme-color', content: '#86EFAC' }], - ['meta', { name: 'author', content: 'Keksi' }], + ['meta', { name: 'author', content: 'Lona Devs' }], ['meta', { property: 'og:type', content: 'website' }], ['meta', { name: 'og:title', content: title }], ['meta', { name: 'og:description', content: description }], @@ -18,11 +18,11 @@ export default defineConfig({ ['meta', { name: 'twitter:title', content: title }], ['meta', { name: 'twitter:card', content: 'summary_large_image' }], ['meta', { name: 'twitter:image', content: ogImage }], - ['meta', { name: 'twitter:site', content: '@keksiqc' }], + ['meta', { name: 'twitter:site', content: '@lona_devs' }], ['meta', { name: 'twitter:url', content: ogUrl }], ], - title: "LonaDB", - description: "JSON based Database written in JavaScript", + title: "Lona Development", + description: "JSON based and written in PHP", themeConfig: { logo: '/favicon.svg', search: { @@ -30,23 +30,15 @@ export default defineConfig({ }, nav: [ - { text: 'Home', link: '/' }, - { text: 'Guide', link: '/guide/getting-started' }, - { text: 'Examples', link: '/guide/examples' }, + { text: 'Home', link: 'https://lona-development.org/' }, + { text: 'Guide', link: '/guide/getting-started' } ], sidebar: [ { text: 'Introduction', items: [ - { text: 'Getting Started', link: '/guide/getting-started' }, - { text: 'Deploy', link: '/guide/deploy' } - ] - }, - { - text: 'Guide', - items: [ - { text: 'Examples', link: '/guide/examples' } + { text: 'Getting Started', link: '/guide/getting-started' } ] } ], diff --git a/guide/deploy.md b/guide/deploy.md deleted file mode 100644 index e69de29..0000000 diff --git a/guide/getting-started.md b/guide/getting-started.md index c041d89..90f7eba 100644 --- a/guide/getting-started.md +++ b/guide/getting-started.md @@ -1,36 +1,35 @@ -## Prerequisites - -To run the LonaDB server, make sure you have the following software installed: - -- Node.js (version 12 or above) -- npm (Node Package Manager) - ## Installation To install the LonaDB server, follow these steps: -1. Clone the repository to your local machine: +1. Run the install script with sudo: ```bash -git clone https://github.com/LonaDB/Hadro.git +sudo curl -fsSL https://lona-development.org/download/install.sh | sh ``` -2. Navigate to the project directory: +2. Start the Server: ```bash -cd Hadro +./start.sh ``` -3. Install the dependencies and start the server: +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 -npm install -node hadro +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. -If you don't have a configuration file, a users file or any tables, the setup script will run you through initial setup and create everything needed for the database to run. +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 now have your own instance of LonaDB's server, Hadro! \ No newline at end of file +You now have your own instance of LonaDB! \ No newline at end of file diff --git a/index.md b/index.md index cb13268..6b680ab 100644 --- a/index.md +++ b/index.md @@ -3,7 +3,7 @@ layout: home hero: name: "LonaDB" - text: "JSON based and written in JavaScript" + text: "JSON based and written in PHP" tagline: Simple, free and Open-Source. actions: - theme: brand @@ -11,18 +11,18 @@ hero: link: /guide/getting-started - theme: alt text: View on GitHub - link: https://github.com/LonaDB/Server + link: https://github.com/LonaDB image: src: /logo_large.svg alt: LonaDB Logo features: - title: What is LonaDB? - details: LonaDB is an early-stage prototype of a JavaScript-based database. It utilizes Binary JSON as its storage format and provides support for multiple users and tables. + details: LonaDB is a prototype of a PHP-based database. It utilizes Encrypted JSON-objects as its storage format and provides support for multiple users and tables. - title: Open-Source! - details: This is a Open-Source Project. This means that anyone can look at our source code. That way, we can't put a license check for example in our project. + details: This is a Open-Source Project. This means that anyone can look at our source code. That way, we can't collect your data. - title: How does it work? - details: Hadro is our database server running in Node.js! It provides Client Libraries for interacting with the database. Also, it utilizes a TCP-Socket for communication with the clients. + details: It's really simple! The Server is installed using a installer script. The Client libraries can be found on npm or pip for examle. If there is no Package Manager for your programming language (or we didn't upload the client on it), you can always check our GitHub profile for a client. - title: Your own instance! details: LonaDB is self-hosted, meaning you can run it on your own server. This allows you to have full control over your data with no one spying. ---