Skip to content

Commit f5aad0b

Browse files
authored
docs: V2 documentation (#44)
1 parent bbb88dc commit f5aad0b

File tree

266 files changed

+3640
-1599
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

266 files changed

+3640
-1599
lines changed

.idea/.gitignore

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/modules.xml

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/swiftwave.org.iml

Lines changed: 12 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/vcs.xml

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

blog/2020-05-28-intro.md

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

docs/cli/auto-update/disable.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
id: disable
3+
title: swiftwave auto-update disable
4+
tags:
5+
- CLI
6+
- Auto Update
7+
sidebar_position: 2
8+
---
9+
10+
Disable Swiftwave Auto Update Service.
11+
12+
13+
### Usage
14+
15+
```
16+
swiftwave auto-update disable
17+
```

docs/cli/auto-update/enable.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
id: enable
3+
title: swiftwave auto-update enable
4+
tags:
5+
- CLI
6+
- Auto Update
7+
sidebar_position: 1
8+
---
9+
10+
Enable Swiftwave Auto Update Service.
11+
12+
:::note
13+
14+
It will check for updates every 15 minutes to apply minor version updates and hotfixes to keep SwiftWave up to date and secured.
15+
16+
:::
17+
18+
### Usage
19+
20+
```
21+
swiftwave auto-update enable
22+
```

docs/cli/auto-update/index.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
id: auto-update
3+
title: swiftwave auto-update
4+
tags:
5+
- CLI
6+
- Auto Update
7+
sidebar_position: 11
8+
---
9+
10+
Auto update is a feature that will automatically update Swiftwave to the latest minor version and apply hotfixes.
11+
12+
### Check available commands
13+
- [**swiftwave auto-update enable**](./enable)
14+
- [**swiftwave auto-update disable**](./disable)

docs/cli/auto-updater/disable.md

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

docs/cli/auto-updater/enable.md

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

docs/cli/auto-updater/index.md

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

docs/cli/db-migrate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: db-migrate
33
title: swiftwave db-migrate
44
tags:
55
- CLI
6-
sidebar_position: 5
6+
sidebar_position: 4
77
---
88

99
Migrate new database changes to the database.

docs/cli/delete-user.md

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

docs/cli/haproxy/index.md

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

docs/cli/haproxy/start.md

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

docs/cli/haproxy/status.md

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

docs/cli/haproxy/stop.md

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

docs/cli/index.md

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,8 @@ sidebar_position: 6
99
SwiftWave CLI acts like a management panel for SwiftWave.
1010
It provides some administrative control as root user of your system.
1111

12-
**Feature List**
13-
- Edit Configuration
14-
- Generate SSL certificate for primary domain
15-
- Migrate Database Tables
16-
- Create/Delete Admin user
17-
- Manage HaProxy Service
18-
- Manage Local Postgres Database
19-
- Manage Swiftwave Service
20-
- Print Swiftwave Service Info
21-
2212
### Global Flags
2313

24-
| Flag | Type | Default | Mandatory | Description |
25-
|--------|------------------|---------|---------------------|-----------------------------------|
26-
| --dev | `true` / `false` | `false` | <center>❌</center> | Run swiftwave in development mode (This will enable some extra features) <ul><li>GraphQL playground will be available</li><li>Logs will be more detailed</li></ul> |
27-
| --help | | | <center>❌</center> | Show information for any command |
14+
| Flag | Type | Default | Mandatory | Description |
15+
| ------ | ---- | ------- | ------------------ | -------------------------------- |
16+
| --help | | | <center>❌</center> | Show information for any command |

docs/cli/info.md

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

docs/cli/init.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,9 @@ swiftwave init [flags]
1717
### Flags
1818

1919

20-
| Flag | Type | Default | Mandatory | Description |
21-
|------------|----------|----------|------------|---------------------------|
22-
| --mode | `standalone` / `cluster` | <center>`standalone`</center> | <center>❌</center> | Mode of operation |
23-
| --letsencrypt-email | string | <center>--</center> | <center>❌</center> | Email address for Let's Encrypt |
24-
| --haproxy-user | string | <center>`admin`</center> | <center>❌</center> | Username for HAProxy (Can't be modified once set) |
25-
| --haproxy-password | string | <center>`admin`</center> | <center>❌</center> | Password for HAProxy (Can't be modified once set) |
26-
| --auto-domain | `true` / `false` | <center>`false`</center> | <center>❌</center> | Resolve domain name automatically |
27-
| --overwrite | `true` / `false` | <center>`false`</center> | <center>❌</center> | Overwrite existing configuration |
20+
| Flag | Type | Default | Mandatory | Description |
21+
| ----------------- | ---------------- | ------------------------ | ------------------ | ---------------------------------------------- |
22+
| --domain | string | | <center>❌</center> | Domain name for management node |
23+
| --auto-domain | `true` / `false` | <center>`false`</center> | <center>❌</center> | Use *.swiftwave.xyz domain for management node |
24+
| --remote-postgres | `true` / `false` | <center>`false`</center> | <center>❌</center> | Opt out Local postgres database |
25+
| --overwrite | `true` / `false` | <center>`false`</center> | <center>❌</center> | Overwrite existing configuration |

docs/cli/localregistry/index.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
id: localregistry
3+
title: swiftwave localregistry
4+
tags:
5+
- CLI
6+
- Local Image Registry
7+
sidebar_position: 10
8+
---
9+
10+
Manage local local image registry
11+
12+
### Check available commands
13+
- [**swiftwave localregistry start**](./start)
14+
- [**swiftwave localregistry stop**](./stop)
15+
- [**swiftwave localregistry restart**](./restart)
16+
- [**swiftwave localregistry status**](./status)

docs/cli/localregistry/restart.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
id: restart
3+
title: swiftwave localregistry restart
4+
tags:
5+
- CLI
6+
- Local Image Registry
7+
sidebar_position: 3
8+
---
9+
10+
Restart local image registry
11+
12+
### Usage
13+
14+
```
15+
swiftwave localregistry restart
16+
```

docs/cli/localregistry/start.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
id: start
3+
title: swiftwave localregistry start
4+
tags:
5+
- CLI
6+
- Local Image Registry
7+
sidebar_position: 1
8+
---
9+
10+
11+
Start local image registry
12+
13+
### Usage
14+
15+
```
16+
swiftwave localregistry start
17+
```

docs/cli/localregistry/status.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
id: status
3+
title: swiftwave localregistry status
4+
tags:
5+
- CLI
6+
- Local Image Registry
7+
sidebar_position: 4
8+
---
9+
10+
Check status of local image registry
11+
12+
### Usage
13+
14+
```
15+
swiftwave localregistry status
16+
```

0 commit comments

Comments
 (0)