Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sunny-chung committed Dec 12, 2023
1 parent 6ba5d81 commit 64c0bae
Show file tree
Hide file tree
Showing 8 changed files with 34 additions and 18 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,9 +128,9 @@ Clearing this directory would reset the application.

## Performance

Honestly, Hello HTTP is not yet performance-oriented. It relies on JVM, so it would demand a significant amount of
memory (about 0.5 GB). But, it still outperforms many web apps. It performs very well on a Windows laptop with 8 GB RAM
without a noticeable performance degrade of other applications.
Honestly, Hello HTTP is not yet performance-oriented. It is not another web app. It relies on JVM, so it demands a
significant amount of memory (about 0.5 GB). But, it still outperforms many web apps. It performs very well on a
Windows laptop with 8 GB RAM without a noticeable performance degrade of other applications.

## Planned

Expand Down
File renamed without changes
2 changes: 1 addition & 1 deletion doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ title: Hello HTTP
[![Release](https://img.shields.io/github/v/release/sunny-chung/hello-http)](https://github.com/sunny-chung/hello-http/releases)

This is a cross-platform HTTP client desktop application for testing HTTP and REST APIs, WebSocket, GraphQL (including
subscriptions) and gRPC endpoints. This is an alternative to Postman, Insomnia REST, etc.
subscriptions) and gRPC endpoints. This is an alternative to Postman, Insomnia REST, etc., but not another web app.

![Screenshot 1](screenshot1.png)
![Screenshot 2](screenshot2.png)
Expand Down
Binary file added doc/_include/ssl-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 0 additions & 12 deletions doc/features/disable-ssl-verification.md

This file was deleted.

28 changes: 28 additions & 0 deletions doc/features/ssl-configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: SSL Configuration
---

# SSL Configuration

![SSL setting](../ssl-config.png)

## Additional Trusted CA Certificates

Additional to the default trusted CA certificates, custom ones can be imported to verify the server identities. Currently,
the accepted format is only DER. A DER certificate can be converted from a PEM certificate using OpenSSL:
```
openssl x509 -in cert.pem -out cert.der -outform DER
```

Imported certificates can be disabled by unchecking the corresponding green tick box, or deleted. Changes to the
original file would not affect imported ones.

Self-signed certificates are also supported at this moment. A warning will be displayed if a non-CA certificate is
imported.

## Disable SSL Verification

SSL certificate verification can be disabled in the [Environment setting](environments).

By default, SSL verification is enabled.

2 changes: 1 addition & 1 deletion doctave.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ navigation:
- path: doc/features/project-and-request-management.md
- path: doc/features/request-examples-and-payload-examples.md
- path: doc/features/environments.md
- path: doc/features/disable-ssl-verification.md
- path: doc/features/ssl-configuration.md
- path: doc/features/functions.md
- path: doc/features/post-flight-actions.md
- path: doc/features/transport-timeline.md
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,7 @@ fun CertificateEditorView(
Box(modifier = Modifier.fillMaxWidth()) {
AppText(text = title, modifier = Modifier.align(Alignment.CenterStart).padding(vertical = 6.dp))
AppTooltipArea(
tooltipText = "Add a certificate in DER format",
tooltipText = "Import a certificate in DER format",
modifier = Modifier.align(Alignment.CenterEnd).padding(end = 4.dp)
) {
AppImageButton(
Expand Down

0 comments on commit 64c0bae

Please sign in to comment.