Update documentation for clarity and consistency
All checks were successful
Build and Deploy Hugo / Deploy Hugo Website (pull_request) Successful in 24s
All checks were successful
Build and Deploy Hugo / Deploy Hugo Website (pull_request) Successful in 24s
Remove emojis and em dash separators Simplify introductory sentences Standardize section headings
This commit is contained in:
Damien
@@ -6,45 +6,38 @@ cascade:
|
||||
type: docs
|
||||
---
|
||||
|
||||
## 🔗 Sources
|
||||
## Sources
|
||||
|
||||
- [📖 Official Documentation](https://smallstep.com/docs/tutorials/)
|
||||
- [🛠️ Step-CA as a systemd Service](https://angrysysadmins.tech/index.php/2022/09/grassyloki/step-ca-run-as-a-systemd-service/)
|
||||
- [🔐 Certificate Management with OpenSSL](https://www.golinuxcloud.com/tutorial-pki-certificates-authority-ocsp/)
|
||||
- [Official documentation](https://smallstep.com/docs/tutorials/)
|
||||
- [Step-CA as a systemd service](https://angrysysadmins.tech/index.php/2022/09/grassyloki/step-ca-run-as-a-systemd-service/)
|
||||
- [Certificate management with OpenSSL](https://www.golinuxcloud.com/tutorial-pki-certificates-authority-ocsp/)
|
||||
|
||||
## 🤖 About Step-CA
|
||||
## About Step-CA
|
||||
|
||||
Step-CA is a clever toolset developed by Smallstep, a company specializing in secure identity management and certificate automation. 🚀
|
||||
Its mission? To simplify setting up and managing your own certificate authorities (CAs) with ease and security!
|
||||
Step-CA is a toolset developed by Smallstep, a company specializing in secure identity management and certificate automation.
|
||||
Its mission is to simplify setting up and managing your own certificate authorities (CAs).
|
||||
|
||||
### Key Features
|
||||
### Key features
|
||||
|
||||
1. **Certificate Authority Management** 🔑
|
||||
Easily configure and manage your own CAs. Create root and intermediate CAs, issue certificates, and handle revocations like a pro.
|
||||
1. Certificate authority management: easily configure and manage your own CAs. Create root and intermediate CAs, issue certificates, and handle revocations.
|
||||
|
||||
2. **Secure Key Management** 🛡️
|
||||
Follows best practices for securely storing and managing keys, ensuring your cryptographic keys stay protected from unauthorized access.
|
||||
2. Secure key management: follows best practices for securely storing and managing keys, so your cryptographic keys stay protected from unauthorized access.
|
||||
|
||||
3. **Automation and Scalability** ⚙️
|
||||
Ideal for small to large-scale deployments. Take advantage of APIs and integrations that automate certificate issuance, renewal, and revocation for a smooth lifecycle.
|
||||
3. Automation and scalability: works for small to large-scale deployments. APIs and integrations automate certificate issuance, renewal, and revocation across the lifecycle.
|
||||
|
||||
4. **Enhanced Security** 🔒
|
||||
Through the use of modern cryptographic algorithms and protocols, Step-CA supports industry-standard X.509 certificates, providing robust encryption and digital signatures.
|
||||
4. Modern cryptography: Step-CA supports industry-standard X.509 certificates using modern cryptographic algorithms and protocols for encryption and digital signatures.
|
||||
|
||||
5. **Infrastructure Integration** 🌐
|
||||
Integrates seamlessly with your existing tools and systems. Supports various authentication methods such as username/password, MFA, and external identity providers.
|
||||
5. Infrastructure integration: integrates with your existing tools and systems, and supports various authentication methods such as username/password, MFA, and external identity providers.
|
||||
|
||||
6. **Auditability and Compliance** 📜
|
||||
With comprehensive logging and auditing capabilities, you can track certificate activity and meet compliance requirements with ease.
|
||||
6. Auditability and compliance: comprehensive logging and auditing let you track certificate activity and meet compliance requirements.
|
||||
|
||||
7. **Developer-Friendly APIs** 👩💻👨💻
|
||||
APIs and SDKs designed for developers make it easy to integrate certificate management into your applications and custom workflows.
|
||||
7. Developer-friendly APIs: APIs and SDKs designed for developers make it easy to integrate certificate management into your applications and custom workflows.
|
||||
|
||||
**In short:** Step-CA by Smallstep is designed to make certificate authority management both fun and hassle-free. Thanks to its secure, scalable, and user-friendly features, you can easily manage your certificates' lifecycle while protecting your infrastructure!
|
||||
Step-CA by Smallstep is built to make certificate authority management straightforward: you manage your certificates' lifecycle while keeping your infrastructure protected.
|
||||
|
||||
## 🚀 Installation
|
||||
## Installation
|
||||
|
||||
### 🔧 Binary Installation
|
||||
### Binary installation
|
||||
|
||||
#### 1. Step CLI
|
||||
|
||||
@@ -60,7 +53,7 @@ wget https://dl.step.sm/gh-release/certificates/docs-ca-install/v0.24.1/step-ca_
|
||||
sudo dpkg -i step-ca_0.24.1_amd64.deb
|
||||
```
|
||||
|
||||
#### 3. Creating a Dedicated User
|
||||
#### 3. Creating a dedicated user
|
||||
|
||||
```bash
|
||||
adduser adminCA
|
||||
@@ -81,8 +74,8 @@ What would you like to name the CA's first provisioner?
|
||||
Choose a password for your CA keys and the first provisioner.
|
||||
✔ [leave empty and we will generate one] :
|
||||
|
||||
Generating root certificate... done! 🎉
|
||||
Generating intermediate certificate... done! 🎊
|
||||
Generating root certificate... done!
|
||||
Generating intermediate certificate... done!
|
||||
|
||||
✔ Root certificate: /home/adminCA/.step/certs/root_ca.crt
|
||||
✔ Root private key: /home/adminCA/.step/secrets/root_ca_key
|
||||
@@ -95,7 +88,7 @@ Generating intermediate certificate... done! 🎊
|
||||
|
||||
Your PKI is ready to go. To generate certificates for individual services, see `step help ca`.
|
||||
|
||||
💌 **FEEDBACK**
|
||||
**Feedback:**
|
||||
The step utility is not instrumented for usage statistics. It does not contact a central server. Your feedback is, however, extremely valuable! Please consider writing to feedback@smallstep.com, joining GitHub Discussions, or joining us on Discord at [https://u.step.sm/discord](https://u.step.sm/discord).
|
||||
```
|
||||
|
||||
@@ -111,10 +104,10 @@ step-ca .step/config/ca.json
|
||||
$ step ca provisioner add acme --type ACME
|
||||
✔ CA Configuration: /home/adminCA/.step/config/ca.json
|
||||
|
||||
Success! Your `step-ca` configuration has been updated. To pick up the new configuration, send a SIGHUP (kill -1 <pid>) or restart the step-ca process. 🎉
|
||||
Success! Your `step-ca` configuration has been updated. To pick up the new configuration, send a SIGHUP (kill -1 <pid>) or restart the step-ca process.
|
||||
```
|
||||
|
||||
#### Running Step-CA as a systemd Service
|
||||
#### Running Step-CA as a systemd service
|
||||
|
||||
Create a file:
|
||||
|
||||
@@ -155,7 +148,7 @@ systemctl daemon-reload
|
||||
systemctl start step-ca.service
|
||||
```
|
||||
|
||||
### 🐳 Docker Installation
|
||||
### Docker installation
|
||||
|
||||
```bash
|
||||
docker run -it -v step:/home/step \
|
||||
@@ -167,11 +160,11 @@ docker run -it -v step:/home/step \
|
||||
smallstep/step-ca
|
||||
```
|
||||
|
||||
## 🔑 Accessing the CA from Another Client
|
||||
## Accessing the CA from another client
|
||||
|
||||
> [!NOTE] Adjust the port based on your installation:
|
||||
> [!NOTE] Adjust the port based on your installation:
|
||||
>
|
||||
> - **Binary:** port **443**
|
||||
> - **Binary:** port **443**
|
||||
> - **Docker:** port **9000**
|
||||
|
||||
Install the Step CLI:
|
||||
@@ -226,7 +219,7 @@ step certificate install $(step path)/certs/root_ca.crt
|
||||
|
||||
---
|
||||
|
||||
### 📝 Obtaining a Certificate
|
||||
### Obtaining a certificate
|
||||
|
||||
```bash
|
||||
admin@User:~$ step ca certificate nas.lab.loc srv.crt srv.key
|
||||
|
||||
Reference in New Issue
Block a user