Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: V2 documentation #44

Merged
merged 14 commits into from
May 30, 2024
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/cli/auto-update/disable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
tanmoysrt marked this conversation as resolved.
Show resolved Hide resolved
id: disable
title: swiftwave auto-update disable
tags:
- CLI
- Auto Update
sidebar_position: 2
---

Disable Swiftwave Auto Update Service.


### Usage

```
swiftwave auto-update disable
```
22 changes: 22 additions & 0 deletions docs/cli/auto-update/enable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
tanmoysrt marked this conversation as resolved.
Show resolved Hide resolved
id: enable
title: swiftwave auto-update enable
tags:
- CLI
- Auto Update
sidebar_position: 1
---

Enable Swiftwave Auto Update Service.

:::note

It will check for updates every 15 minutes to apply minor version updates and hotfixes to keep SwiftWave up to date and secured.

:::

### Usage

```
swiftwave auto-update enable
```
14 changes: 14 additions & 0 deletions docs/cli/auto-update/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
tanmoysrt marked this conversation as resolved.
Show resolved Hide resolved
id: auto-update
title: swiftwave auto-update
tags:
- CLI
- Auto Update
sidebar_position: 11
---

Auto update is a feature that will automatically update Swiftwave to the latest minor version and apply hotfixes.

### Check available commands
- [**swiftwave auto-update enable**](/docs/cli/auto-update/enable)
- [**swiftwave auto-update disable**](/docs/cli/auto-update/disable)
17 changes: 0 additions & 17 deletions docs/cli/auto-updater/disable.md

This file was deleted.

25 changes: 0 additions & 25 deletions docs/cli/auto-updater/enable.md

This file was deleted.

14 changes: 0 additions & 14 deletions docs/cli/auto-updater/index.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/cli/db-migrate.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: db-migrate
title: swiftwave db-migrate
tags:
- CLI
sidebar_position: 5
sidebar_position: 4
---

Migrate new database changes to the database.
Expand Down
16 changes: 0 additions & 16 deletions docs/cli/delete-user.md

This file was deleted.

15 changes: 0 additions & 15 deletions docs/cli/haproxy/index.md

This file was deleted.

16 changes: 0 additions & 16 deletions docs/cli/haproxy/start.md

This file was deleted.

16 changes: 0 additions & 16 deletions docs/cli/haproxy/status.md

This file was deleted.

17 changes: 0 additions & 17 deletions docs/cli/haproxy/stop.md

This file was deleted.

17 changes: 3 additions & 14 deletions docs/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,8 @@ sidebar_position: 6
SwiftWave CLI acts like a management panel for SwiftWave.
It provides some administrative control as root user of your system.

**Feature List**
- Edit Configuration
- Generate SSL certificate for primary domain
- Migrate Database Tables
- Create/Delete Admin user
- Manage HaProxy Service
- Manage Local Postgres Database
- Manage Swiftwave Service
- Print Swiftwave Service Info

### Global Flags

| Flag | Type | Default | Mandatory | Description |
|--------|------------------|---------|---------------------|-----------------------------------|
| --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> |
| --help | | | <center>❌</center> | Show information for any command |
| Flag | Type | Default | Mandatory | Description |
| ------ | ---- | ------- | ------------------ | -------------------------------- |
| --help | | | <center>❌</center> | Show information for any command |
17 changes: 0 additions & 17 deletions docs/cli/info.md

This file was deleted.

14 changes: 6 additions & 8 deletions docs/cli/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,9 @@ swiftwave init [flags]
### Flags


| Flag | Type | Default | Mandatory | Description |
|------------|----------|----------|------------|---------------------------|
| --mode | `standalone` / `cluster` | <center>`standalone`</center> | <center>❌</center> | Mode of operation |
| --letsencrypt-email | string | <center>--</center> | <center>❌</center> | Email address for Let's Encrypt |
| --haproxy-user | string | <center>`admin`</center> | <center>❌</center> | Username for HAProxy (Can't be modified once set) |
| --haproxy-password | string | <center>`admin`</center> | <center>❌</center> | Password for HAProxy (Can't be modified once set) |
| --auto-domain | `true` / `false` | <center>`false`</center> | <center>❌</center> | Resolve domain name automatically |
| --overwrite | `true` / `false` | <center>`false`</center> | <center>❌</center> | Overwrite existing configuration |
| Flag | Type | Default | Mandatory | Description |
| ----------------- | ---------------- | ------------------------ | ------------------ | ---------------------------------------------- |
| --domain | string | | <center>❌</center> | Domain name for management node |
| --auto-domain | `true` / `false` | <center>`false`</center> | <center>❌</center> | Use *.swiftwave.xyz domain for management node |
| --remote-postgres | `true` / `false` | <center>`false`</center> | <center>❌</center> | Opt out Local postgres database |
| --overwrite | `true` / `false` | <center>`false`</center> | <center>❌</center> | Overwrite existing configuration |
16 changes: 16 additions & 0 deletions docs/cli/localregistry/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
tanmoysrt marked this conversation as resolved.
Show resolved Hide resolved
id: localregistry
title: swiftwave localregistry
tags:
- CLI
- Local Image Registry
sidebar_position: 10
---

Manage local local image registry
tanmoysrt marked this conversation as resolved.
Show resolved Hide resolved

### Check available commands
- [**swiftwave localregistry start**](/docs/cli/localregistry/start)
- [**swiftwave localregistry stop**](/docs/cli/localregistry/stop)
- [**swiftwave localregistry restart**](/docs/cli/localregistry/restart)
- [**swiftwave localregistry status**](/docs/cli/localregistry/status)
16 changes: 16 additions & 0 deletions docs/cli/localregistry/restart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING

id: restart
title: swiftwave localregistry restart
tags:
- CLI
- Local Image Registry
sidebar_position: 3
---

Restart local image registry

### Usage

```
swiftwave localregistry restart
```
17 changes: 17 additions & 0 deletions docs/cli/localregistry/start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING

id: start
title: swiftwave localregistry start
tags:
- CLI
- Local Image Registry
sidebar_position: 1
---


Start local image registry

### Usage

```
swiftwave localregistry start
```
16 changes: 16 additions & 0 deletions docs/cli/localregistry/status.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING

id: status
title: swiftwave localregistry status
tags:
- CLI
- Local Image Registry
sidebar_position: 4
---

Check status of local image registry

### Usage

```
swiftwave localregistry status
```
16 changes: 16 additions & 0 deletions docs/cli/localregistry/stop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING

id: stop
title: swiftwave localregistry stop
tags:
- CLI
- Local Image Registry
sidebar_position: 2
---

Stop local image registry

### Usage

```
swiftwave localregistry stop
```
6 changes: 3 additions & 3 deletions docs/cli/postgres/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
id: swiftwave-postgres
id: postgres
title: swiftwave postgres
tags:
- CLI
- Database
sidebar_position: 12
sidebar_position: 9
---

Manage local postgres database (Only for standalone installation) [Not recommended]
Manage local postgres database

### Check available commands
- [**swiftwave postgres start**](/docs/cli/postgres/start)
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/postgres/start.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_position: 1
---


Start local postgres database (Recommended only for standalone installations)
Start local postgres database

### Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/postgres/status.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags:
sidebar_position: 3
---

Check status of local postgres database (Recommended only for standalone installations)
Check status of local postgres database

### Usage

Expand Down
Loading
Loading