Update docs

This commit is contained in:
Collin 2024-02-02 14:38:22 +00:00
parent a25be98c34
commit 719e97815c
4 changed files with 28 additions and 37 deletions

View File

@ -2,7 +2,7 @@ import { defineConfig } from 'vitepress'
const ogUrl = 'https://lona.js.org/' const ogUrl = 'https://lona.js.org/'
const ogImage = `${ogUrl}og.png#1` const ogImage = `${ogUrl}og.png#1`
const title = 'LonaDB' const title = 'Lona Development'
const description = 'JSON based Database written in JavaScript' const description = 'JSON based Database written in JavaScript'
// https://vitepress.dev/reference/site-config // https://vitepress.dev/reference/site-config
@ -10,7 +10,7 @@ export default defineConfig({
head: [ head: [
['link', { rel: 'icon', href: '/favicon.svg', type: 'image/svg+xml' }], ['link', { rel: 'icon', href: '/favicon.svg', type: 'image/svg+xml' }],
['meta', { name: 'theme-color', content: '#86EFAC' }], ['meta', { name: 'theme-color', content: '#86EFAC' }],
['meta', { name: 'author', content: 'Keksi' }], ['meta', { name: 'author', content: 'Lona Devs' }],
['meta', { property: 'og:type', content: 'website' }], ['meta', { property: 'og:type', content: 'website' }],
['meta', { name: 'og:title', content: title }], ['meta', { name: 'og:title', content: title }],
['meta', { name: 'og:description', content: description }], ['meta', { name: 'og:description', content: description }],
@ -18,11 +18,11 @@ export default defineConfig({
['meta', { name: 'twitter:title', content: title }], ['meta', { name: 'twitter:title', content: title }],
['meta', { name: 'twitter:card', content: 'summary_large_image' }], ['meta', { name: 'twitter:card', content: 'summary_large_image' }],
['meta', { name: 'twitter:image', content: ogImage }], ['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 }], ['meta', { name: 'twitter:url', content: ogUrl }],
], ],
title: "LonaDB", title: "Lona Development",
description: "JSON based Database written in JavaScript", description: "JSON based and written in PHP",
themeConfig: { themeConfig: {
logo: '/favicon.svg', logo: '/favicon.svg',
search: { search: {
@ -30,23 +30,15 @@ export default defineConfig({
}, },
nav: [ nav: [
{ text: 'Home', link: '/' }, { text: 'Home', link: 'https://lona-development.org/' },
{ text: 'Guide', link: '/guide/getting-started' }, { text: 'Guide', link: '/guide/getting-started' }
{ text: 'Examples', link: '/guide/examples' },
], ],
sidebar: [ sidebar: [
{ {
text: 'Introduction', text: 'Introduction',
items: [ items: [
{ text: 'Getting Started', link: '/guide/getting-started' }, { text: 'Getting Started', link: '/guide/getting-started' }
{ text: 'Deploy', link: '/guide/deploy' }
]
},
{
text: 'Guide',
items: [
{ text: 'Examples', link: '/guide/examples' }
] ]
} }
], ],

View File

View File

@ -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 ## Installation
To install the LonaDB server, follow these steps: To install the LonaDB server, follow these steps:
1. Clone the repository to your local machine: 1. Run the install script with sudo:
```bash ```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 ```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 ```bash
npm install printf "yourEncryptionKey\n" | php ...
node hadro
``` ```
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: 4. Use your database:
Thats it! Thats it!
You now have your own instance of LonaDB's server, Hadro! You now have your own instance of LonaDB!

View File

@ -3,7 +3,7 @@ layout: home
hero: hero:
name: "LonaDB" name: "LonaDB"
text: "JSON based and written in JavaScript" text: "JSON based and written in PHP"
tagline: Simple, free and Open-Source. tagline: Simple, free and Open-Source.
actions: actions:
- theme: brand - theme: brand
@ -11,18 +11,18 @@ hero:
link: /guide/getting-started link: /guide/getting-started
- theme: alt - theme: alt
text: View on GitHub text: View on GitHub
link: https://github.com/LonaDB/Server link: https://github.com/LonaDB
image: image:
src: /logo_large.svg src: /logo_large.svg
alt: LonaDB Logo alt: LonaDB Logo
features: features:
- title: What is LonaDB? - 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! - 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? - 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! - 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. 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.
--- ---