Skip to content
This repository was archived by the owner on Mar 12, 2026. It is now read-only.

Commit 33ad38d

Browse files
committed
docs: fix mkdocs merge
1 parent 2bb254b commit 33ad38d

6 files changed

Lines changed: 19 additions & 123 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Cosmian KMS
22

3-
![Build status](https://github.com/Cosmian/kms/actions/workflows/ci.yml/badge.svg?branch=main)
3+
![Build status](https://github.com/Cosmian/kms/actions/workflows/main_release.yml/badge.svg?branch=main)
44

55
Cosmian KMS is an implementation of a high-performance, massively scalable, **Key
66
Management System** that presents some unique features, such as
@@ -12,7 +12,7 @@ Management System** that presents some unique features, such as
1212
- a JSON KMIP 2.1 compliant interface
1313
- support for object tagging to easily manage keys and secrets
1414
- a full-featured command line and graphical
15-
interface ([CLI](https://docs.cosmian.com/cosmian_key_management_system/cli/cli/))
15+
interface ([CLI](https://docs.cosmian.com/cosmian_cli/))
1616
- Python, Javascript, Dart, Rust, C/C++, and Java clients (see the `cloudproof` libraries
1717
on [Cosmian Github](https://github.com/Cosmian))
1818
- FIPS 140-2 mode gated behind the feature `fips`

crate/cli/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
# Cosmian KMS CLI
1+
# Cosmian CLI
22

3-
Cosmian KMS can be managed using the `ckms` command line interface (CLI) or its graphical
4-
client `ckms_gui`.
3+
Cosmian KMS can be managed using the `cosmian` command line interface (CLI) or its graphical
4+
client `cosmian_gui`.
55

66
## Build
77

88
```sh
9-
cargo build --bin ckms
9+
cargo build --bin cosmian
1010
```
1111

1212
## Usage
1313

14-
[Usage](../../documentation/docs/cli/cli.md)
14+
[Usage](../../documentation/docs/index.md)
1515

1616
## Testing
1717

1818
```sh
19-
cargo build --bin ckms
20-
cargo test -p ckms
19+
cargo build --bin cosmian
20+
cargo test -p cosmian
2121
```

documentation/docs/authentication.md

Lines changed: 0 additions & 101 deletions
This file was deleted.

documentation/docs/configuration.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,9 @@ clear_database = false
2121
[http]
2222
port = 6668
2323
hostname = "0.0.0.0"
24-
25-
[auth]
2624
```
2725

28-
## Example with X509 authentication
26+
## Example with PKCS12 authentication
2927

3028
```toml
3129
default_username = "admin"
@@ -42,8 +40,6 @@ hostname = "0.0.0.0"
4240
https_p12_file = "/etc/cosmian/certificates/server/findex.server.acme.com.p12"
4341
https_p12_password = "password"
4442
authority_cert_file = "/etc/cosmian/certificates/server/ca.crt"
45-
46-
[auth]
4743
```
4844

4945
## Example with OpenID authentication

documentation/docs/index.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,9 @@ The Cosmian CLI is the Command Line Interface to interact with Cosmian products
1717

1818
## Installation
1919

20-
<!-- {!../cli/documentation/docs/installation.md!} -->
21-
{!./installation.md!}
20+
<!-- Warning: this doc is merged with `mkdocs merge` in the repository `public_documentation`. -->
21+
<!-- To test locally, test with path `installation.md` -->
22+
{!../cli/documentation/docs/installation.md!}
2223

2324
## Configuring the clients
2425

@@ -159,5 +160,6 @@ universe_domain = "googleapis.com"
159160

160161
## Usage
161162

162-
<!-- {!../cli/documentation/docs/usage.md!} -->
163-
{!./usage.md!}
163+
<!-- Warning: this doc is merged with `mkdocs merge` in the repository `public_documentation`. -->
164+
<!-- To test locally, test with path `usage.md` -->
165+
{!../cli/documentation/docs/usage.md!}

documentation/mkdocs.yml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
site_name: Cosmian CLI
2+
site_name: Command Line Interface
33
site_url: https://docs.cosmian.com/
44
copyright: © Copyright 2018-2024 Cosmian. All rights reserved
55
dev_addr: localhost:8003
@@ -53,8 +53,7 @@ plugins:
5353
nav:
5454
- Getting started: index.md
5555
- Installation: installation.md
56-
- User authentication: authentication.md
5756
- Configuration:
58-
Configuration file: configuration.md
59-
Usage: usage.md
57+
- Configuration file: configuration.md
58+
- Usage: usage.md
6059
- User manual: cli/main_commands.md

0 commit comments

Comments
 (0)