Skip to content

Commit 5e5892a

Browse files
committed
docs: refinemets
1 parent 627d89b commit 5e5892a

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

docs/how-to/kubo-tls.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ title: TLS and HTTP Auth for Kubo
33
description: Learn how to set up TLS for Kubo with Caddy reverse proxy for secure API access over public networks.
44
---
55

6-
# Setting up TLS and basic HTTP auth for Kubo with Caddy reverse proxy
6+
# Setting up TLS and HTTP authentication for Kubo with Caddy reverse proxy
77

88
This guide will help you set up two things:
99

10-
- **Transport Encryption:** Caddy as a reverse proxy with automatic TLS certificate management for your Kubo node.
11-
- **Authentication:** Basic HTTP auth for the Kubo RPC API.
10+
- **Transport Encryption:** Caddy as a reverse proxy with automatic TLS certificate management for your Kubo node using a domain you control.
11+
- **Authentication:** Basic HTTP authentication for the Kubo RPC API.
1212

13-
This is highly recommended if you run your own Kubo node and want to use the Kubo RPC API over public networks, for example, to pin data from CI, or other services. Since the Kubo RPC API is exposed over plain HTTP, you will need to use TLS to ensure the connection to the API is encrypted.
13+
This is highly recommended if you run your own Kubo node and want to use the Kubo RPC API over public networks, for example, to pin CIDs from CI, or other services. Since the Kubo RPC API is exposed over plain HTTP, TLS is used to ensure the connection to the API is encrypted.
1414

1515
## Prerequisites
1616

@@ -21,6 +21,8 @@ Before starting, ensure you have:
2121
- Port 443 open on your server's firewall
2222
- [Caddy web server](https://caddyserver.com/) installed on the server
2323

24+
The guide assumes the Caddy process is managed by systemd. If you are using a different process manager or Docker, you will need to adjust the configuration accordingly.
25+
2426
## Configure Kubo
2527

2628
First, you'll need to configure Kubo to work with the reverse proxy. Edit your Kubo config file (usually located at `~/.ipfs/config`) and update the API section:
@@ -72,19 +74,21 @@ This configuration:
7274

7375
## Restart Caddy
7476

77+
Restart the Caddy service to apply the changes:
78+
7579
```bash
7680
sudo systemctl restart caddy
7781
```
7882

7983
## Test the Connection
8084

81-
To verify everything is working correctly, test the connection using the IPFS CLI:
85+
To verify everything is working correctly, test the connection using the IPFS CLI, making sure to replace `YOUR_DOMAIN` with your actual domain name:
8286

8387
```bash
8488
ipfs id --api /dns/YOUR_DOMAIN/tcp/443/https --api-auth basic:hello:world123
8589
```
8690

87-
If successful, you should see your node's information displayed. The command connects to your Kubo node through the secure HTTPS endpoint using basic authentication.
91+
If successful, you should see your node's identify displayed. The command connects to your Kubo node through the secure HTTPS endpoint using basic authentication.
8892

8993
## Security Considerations
9094

@@ -98,6 +102,6 @@ If successful, you should see your node's information displayed. The command con
98102
If you encounter issues:
99103

100104
1. Check Caddy logs
101-
2. Verify your domain's DNS settings, ensuring the A record is correct
105+
2. Verify your domain's DNS settings, ensuring the A record is correct. Sometimes changes can take a few minutes to propagate (depending on the TTL of the DNS record).
102106
3. Ensure port 443 is open and not blocked by your firewall
103107
4. Check that Kubo is running and accessible on localhost:5001

0 commit comments

Comments
 (0)