From 094b8d547baa11dbafb0464b2f822c7c863ccc47 Mon Sep 17 00:00:00 2001 From: JesusPerez Date: Wed, 8 Sep 2021 19:30:03 +0100 Subject: [PATCH] chore: add links, change title --- README.md | 40 +++++++++++++++++++++++++++++----------- 1 file changed, 29 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 15d25fa..70f457b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Fork me on GitHub -## WebServices and Clouds Monitoring +## WebServices and Clouds Monitoring for LibreCloud This was created to play and sync different roles: @@ -12,7 +12,7 @@ This was created to play and sync different roles: - Handle pre-configured routes for requests (GET/POST) - Use SSL for HTTPS webservers - Serve web client frontend applications and provide them sign-on mechanism -- Run a websever with templates (Tera) multi-language and style customized +- Run a websever with templates [Tera](https://tera.netlify.app) multi-language and style customized - Run as a File server from a preconfigured directory - Implement authenticated files upload (backend & frontend via templates) @@ -23,15 +23,15 @@ This was created to play and sync different roles: ### As DataServer -- Manage Data sets from or to (json,yaml,toml) +- Manage Data sets from or to (JSON,YAML,TOML) - Use several alternatives as data store (in memory, key-value) - Simple data caching or preload -- Use async GraphQL or API mode to handle data requests +- Use [Async GraphQL](https://async-graphql.github.io/async-graphql/en/index.html) or API mode to handle data requests ### As Authentication / Authorization server - Manage JSON Web Tokens [JWT](https://en.wikipedia.org/wiki/JSON_Web_Token) -- Include simple authentication and user authorization policies. (casbin) +- Include simple authentication and user authorization policies. [Casbin](https://casbin.org/) - Handle User login/logout with several Data store - Manage Sessions and profiles in key-value storage - Able to encrypt/decrypt data @@ -55,29 +55,29 @@ To explore Rust programming language excelence for backend services, handle web [ZTerton](/LibreCloud/ZTerton) code relies on [LibreCloud Libraries](LibreCloud) with different funcionalities for backend developments, so it feeds libraries to reuse code as much as it is possible, by follwing priciple of: to make good programs use the very best libraries. -To elevate all [CloudMandala(/LibreCloud/CloudMandala)] definitions, settings and management to a next level: +To elevate all [CloudMandala](/LibreCloud/CloudMandala) definitions, settings and management to a next level: - A way to collect Cloud settings for frontend web client to create Cloud dashboards - A Cloud resources state watcher with preconfigured rules to apply according or in response to predictable states ## Inspiration -[Terton](https://en.wikipedia.org/wiki/Tert%C3%B6n) is a term within Tibetan Buddhism meaning a person who is a discoverer of ancient hidden texts or [terma](https://en.wikipedia.org/wiki/Terma_(religion)). The Termas are sometimes objects like statues, and can also exist as dharma texts and experiences. Tertöns discover the texts at the right time and place. +[Terton](https://en.wikipedia.org/wiki/Tert%C3%B6n) is a term within Tibetan Buddhism meaning a person who is a discoverer of ancient hidden texts or [terma](https://en.wikipedia.org/wiki/Terma_(religion)). The Termas are sometimes objects like statues, and can also exist as dharma texts and experiences. [Tertöns](https://en.wikipedia.org/wiki/Tert%C3%B6n) discover the texts at the right time and place. [ZTerton](/LibreCloud/ZTerton) was conceived as a __Bridge__ (image in logo) to achive latest **Z** [termas](https://en.wikipedia.org/wiki/Terma_(religion)) as resources or data from __sources of truth__. ## Build -Build is automated in [Rlung](/) repository as a CD/CI in [LibreCloud](/librecloud) Cloud: +Build is automated in [Rlung](/) repository as a [CD/CI](https://en.wikipedia.org/wiki/CI/CD) in [LibreCloud](/librecloud) Clouds infraestructure: - Release is build upon request - Binaries for some platforms are build and published as release attachments ### Requirements for build -- Rust infraestructure for Linux or MacOs platforms -- JQ, YQ as tools to handle json and yaml +- [Rust](https://www.rust-lang.org/) infraestructure for Linux or MacOs platforms +- [JQ](https://stedolan.github.io/jq/), [YQ](https://mikefarah.gitbook.io/yq/) as tools to handle JSON and YAML ### Build from source @@ -104,7 +104,7 @@ copy target/release/zterton /usr/local/bin Several components are need it, due to [ZTerton](/LibreCloud/ZTerton) modularity and configurability, a lot of features and funcionalities can be set, enable, extended, etc. -In some specific cases like: data sources, data storage, graphql, etc some rust coding is need it. +In some specific cases like: data sources, data storage, [graphql](https://graphql.org/), etc some rust coding is need it. ### Resources @@ -114,6 +114,24 @@ In some specific cases like: data sources, data storage, graphql, etc some rust - languages - modules +### Run arguments + +```txt +ZTerton: WebServices and Clouds Monitoring for LibreCloud + +USAGE: + zterton [OPTIONS] + +FLAGS: + -h, --help Prints help information + -V, --version Prints version information + +OPTIONS: + -c, --config config + -d, --debug Debug level + -e, --env environment +``` + ### Configuration - File **config.toml**