Skip to content

Commit e15cdd2

Browse files
committed
fix: all image links can no longer rely on the remark hack
1 parent 4e39c03 commit e15cdd2

File tree

4 files changed

+44
-27
lines changed

4 files changed

+44
-27
lines changed

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The documentation is structured using
1919
- [Reference](./reference/) - these are useful when you need remember how to use
2020
a particular command or function
2121

22-
<img src="/images/divio_quadrant.png" width="100%" />
22+
<img src={require('@site/images/divio_quadrant.png').default} width="100%" />
2323

2424
## Introduction
2525

docs/reference/polykey-core/audit.md

Lines changed: 34 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
11
# Audit
22

3-
The Audit system in Polykey provides a way to track and retrieve events that occur within the Polykey agent. This feature is essential for security monitoring, troubleshooting, and compliance purposes.
3+
The Audit system in Polykey provides a way to track and retrieve events that
4+
occur within the Polykey agent. This feature is essential for security
5+
monitoring, troubleshooting, and compliance purposes.
46

57
## Overview
68

7-
The Audit system records various events that occur during the operation of a Polykey node. These events are stored in a structured format and can be retrieved for analysis. The system is designed to be efficient and secure, with events stored in the node's database.
9+
The Audit system records various events that occur during the operation of a
10+
Polykey node. These events are stored in a structured format and can be
11+
retrieved for analysis. The system is designed to be efficient and secure, with
12+
events stored in the node's database.
813

914
## Core Components
1015

1116
### Audit Class
1217

13-
The `Audit` class is the main component of the audit system. It provides methods for:
18+
The `Audit` class is the main component of the audit system. It provides methods
19+
for:
1420

1521
- Recording audit events
1622
- Retrieving audit events
@@ -22,13 +28,15 @@ Audit events have the following structure:
2228

2329
- `id`: A unique identifier for the event (AuditEventId)
2430
- `path`: An array of strings representing the event category/path
25-
- `data`: The event data, which can contain any relevant information about the event
31+
- `data`: The event data, which can contain any relevant information about the
32+
event
2633

2734
## Usage
2835

2936
### Retrieving Audit Events
3037

31-
Audit events can be retrieved from a node using the `nodesAuditEventsGet` RPC method. This method supports:
38+
Audit events can be retrieved from a node using the `nodesAuditEventsGet` RPC
39+
method. This method supports:
3240

3341
- Pagination through `seek` and `seekEnd` parameters
3442
- Limiting the number of results with the `limit` parameter
@@ -39,10 +47,10 @@ Example usage through the node connection:
3947
```typescript
4048
// Retrieve audit events from a connected node
4149
const response = await nodeConnection.getClient().methods.nodesAuditEventsGet({
42-
seek: 0, // Start from the beginning or specific audit event ID
43-
seekEnd: Date.now(), // End at current time or specific audit event ID
44-
limit: 100, // Limit the number of results
45-
order: 'asc' // Order results (asc or desc)
50+
seek: 0, // Start from the beginning or specific audit event ID
51+
seekEnd: Date.now(), // End at current time or specific audit event ID
52+
limit: 100, // Limit the number of results
53+
order: 'asc', // Order results (asc or desc)
4654
});
4755

4856
// Process the audit events
@@ -55,21 +63,28 @@ for await (const auditEvent of response) {
5563

5664
### Event Types
5765

58-
The audit system can record various types of events, including but not limited to:
66+
The audit system can record various types of events, including but not limited
67+
to:
5968

6069
- Node connection events (e.g., `['node', 'connection', 'forward']`)
6170
- Authentication events (e.g., `['auth', 'success']`, `['auth', 'failure']`)
6271
- Vault operations (e.g., `['vault', 'create']`, `['vault', 'delete']`)
6372
- Secret access events (e.g., `['secret', 'read']`, `['secret', 'write']`)
64-
- Permission changes (e.g., `['permission', 'grant']`, `['permission', 'revoke']`)
73+
- Permission changes (e.g., `['permission', 'grant']`,
74+
`['permission', 'revoke']`)
6575

66-
Each event type has a specific path structure and data format. The path is an array of strings that categorizes the event, while the data contains relevant information specific to that event type.
76+
Each event type has a specific path structure and data format. The path is an
77+
array of strings that categorizes the event, while the data contains relevant
78+
information specific to that event type.
6779

6880
## Security Considerations
6981

70-
Audit events are stored locally on the node and are only accessible to authorized users with appropriate permissions. When retrieving audit events from another node, proper authentication and authorization are required.
82+
Audit events are stored locally on the node and are only accessible to
83+
authorized users with appropriate permissions. When retrieving audit events from
84+
another node, proper authentication and authorization are required.
7185

72-
The audit system is designed to be secure and tamper-resistant, ensuring that audit events cannot be modified or deleted without proper authorization.
86+
The audit system is designed to be secure and tamper-resistant, ensuring that
87+
audit events cannot be modified or deleted without proper authorization.
7388

7489
## Integration with Other Components
7590

@@ -99,8 +114,10 @@ The audit system is implemented using the following key files:
99114
- `src/audit/Audit.ts`: The main Audit class implementation
100115
- `src/audit/types.ts`: Type definitions for audit events
101116
- `src/audit/utils.ts`: Utility functions for audit operations
102-
- `src/nodes/agent/handlers/NodesAuditEventsGet.ts`: Handler for retrieving audit events
103-
- `src/nodes/agent/callers/nodesAuditEventsGet.ts`: Caller for the audit events RPC method
117+
- `src/nodes/agent/handlers/NodesAuditEventsGet.ts`: Handler for retrieving
118+
audit events
119+
- `src/nodes/agent/callers/nodesAuditEventsGet.ts`: Caller for the audit events
120+
RPC method
104121

105122
## Future Enhancements
106123

@@ -110,4 +127,4 @@ Future versions of the audit system may include:
110127
- Enhanced filtering capabilities based on event paths and data
111128
- Export functionality for audit logs to common formats (CSV, JSON)
112129
- Integration with external logging systems (Syslog, ELK stack)
113-
- Real-time audit event notifications
130+
- Real-time audit event notifications

docs/theory/decentralized-trust-network.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Slack).
2626

2727
<p align="center">
2828
<figure>
29-
<img src="/images/gestalts-and-DIs/di-ceos.png" width="60%" />
29+
<img src={require('@site/images/gestalts-and-DIs/di-ceos.png').default} width="60%" />
3030
<br />
3131
<figcaption>From top left to bottom: Digital identities for the CEOs of Twitter, GitHub, LinkedIn, and FaceBook</figcaption>
3232
</figure>
@@ -141,7 +141,7 @@ a [X.509 certificate](https://en.wikipedia.org/wiki/X.509).
141141

142142
<p align="center">
143143
<figure>
144-
<img src="/images/divio_quadrant.png" width="100%" />
144+
<img src={require('@site/images/divio_quadrant.png').default} width="100%" />
145145
<br />
146146
<figcaption>X.509 certificates act as the root of trust for Polykey Sigchains</figcaption>
147147
</figure>
@@ -175,7 +175,7 @@ Keynodes and digital identities as its vertices.
175175

176176
<p align="center">
177177
<figure>
178-
<img src="/images/gestalts-and-DIs/GestaltDiagram.png" width="70%" />
178+
<img src={require('@site/images/gestalts-and-DIs/GestaltDiagram.png').default} width="70%" />
179179
<br />
180180
<figcaption>Visual depiction of a Polykey Gestalt</figcaption>
181181
</figure>
@@ -210,7 +210,7 @@ distributed clients.
210210

211211
<p align="center">
212212
<figure>
213-
<img src="/images/gestalts-and-DIs/keybase.png" width="70%" />
213+
<img src={require('@site/images/gestalts-and-DIs/keybase.png').default} width="70%" />
214214
<br />
215215
<figcaption>Digital identity augmentation as implemented within Keybase</figcaption>
216216
</figure>
@@ -247,15 +247,15 @@ stages, however, only the final three belong to the augmentation itself:
247247

248248
<p align="center">
249249
<figure>
250-
<img src="/images/gestalts-and-DIs/augmentation.png" width="90%" />
250+
<img src={require('@site/images/gestalts-and-DIs/augmentation.png').default} width="90%" />
251251
<br />
252252
<figcaption>Polykey's Digital Identity (DI) augmentation process</figcaption>
253253
</figure>
254254
</p>
255255

256256
<p align="center">
257257
<figure>
258-
<img src="/images/gestalts-and-DIs/augmentationv3.png" width="90%" />
258+
<img src={require('@site/images/gestalts-and-DIs/augmentationv3.png').default} width="90%" />
259259
<br />
260260
<figcaption>Structure of a cryptolink generated via augmentation</figcaption>
261261
</figure>
@@ -342,7 +342,7 @@ communicate with.
342342

343343
<p align="center">
344344
<figure>
345-
<img src="/images/gestalts-and-DIs/gestalt-discovery.png" width="90%" />
345+
<img src={require('@site/images/gestalts-and-DIs/gestalt-discovery.png').default} width="90%" />
346346
<br />
347347
<figcaption>The Gestalt Discovery process</figcaption>
348348
</figure>
@@ -355,7 +355,7 @@ functionality and application.
355355

356356
<p align="center">
357357
<figure>
358-
<img src="/images/gestalts-and-DIs/gestalt-trust-chain.png" width="90%" />
358+
<img src={require('@site/images/gestalts-and-DIs/gestalt-trust-chain.png').default} width="90%" />
359359
<br />
360360
<figcaption>The beginnings of a trust network formed by Gestalts</figcaption>
361361
</figure>

docs/tutorials/polykey-cli/claiming-digital-identities.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ After successfully authenticating with GitHub, you can claim your identity. This
100100
involves posting a cryptographic link to a publicly verifiable location, such as
101101
a GitHub gist. This link serves as proof of ownership of the identity.
102102

103-
<img src="/images/cryptolink.png" alt="Cryptolink"
103+
<img src={require('@site/images/cryptolink.png').default} alt="Cryptolink"
104104
style={{ width: '70%', height: 'auto' }} />
105105

106106
### Command Usage

0 commit comments

Comments
 (0)