docserver/README.md

27 lines
1.5 KiB
Markdown
Raw Permalink Normal View History

2024-08-14 17:17:25 +00:00
2024-08-14 17:51:51 +00:00
# [Doc Server](./)
2024-08-14 17:17:25 +00:00
2024-08-14 17:51:51 +00:00
Documentation Services for multiple docs content with access restricions and permissions
<img style="margin: 1em 0em;border: 0" width="250" alt="DocServer" src="images/docserver-w.png?sanitize=true">
2024-08-14 17:56:43 +00:00
2024-08-14 18:13:36 +00:00
>
2024-08-14 18:04:06 +00:00
> [Doc Server](./) is a **Web Server** in [Rust](https://www.rust-lang.org) for [static content](./docs/static_content.md)
2024-08-14 17:41:44 +00:00
with **Control access** via [authorizations](./docs/auths.md), fully customizable with [settings](./docs/settings.md).
> [!WARNING]
2024-08-14 18:04:06 +00:00
> Code here needs a fulll review and documentation
2023-07-19 11:35:21 +00:00
2024-08-14 17:51:51 +00:00
> [!CAUTION]
2024-08-14 18:13:36 +00:00
> [dist_docserver_book](dist_docserver_book) will be updated with documentation content generated via [mdbook](/jesus/mdbook) source
2024-08-14 17:51:51 +00:00
## Features
Can use one server instance for all Documentations in contexts/use-cases with sessions, users/groups access
2024-08-14 18:13:36 +00:00
- <b>Documentation</b> for publishing or local build with original [Rust mdbook](/jesus/mdbook) fixed for absolute links and officially reported
2024-08-14 17:55:27 +00:00
- <u>Rust web server for [mdbooks](https://rust-lang.github.io/mdBook)</u> created with authentication and authorizations (permissions based on roles)
- <b>Control access</b> for static content like documentation (books and code) with a lot of options for settings
2024-08-14 17:51:51 +00:00
- <b>Documentations access control and info</b> for users and groups allows separating content for development, distribution or future versions, etc.
2024-08-14 17:55:27 +00:00
- Can run <b>under one instance server</b>, can be implemented in a local or public infrastructure with automations CD/CI