Skip to content

Commit

Permalink
docs: V2 documentation (#44)
Browse files Browse the repository at this point in the history
  • Loading branch information
tanmoysrt authored May 30, 2024
1 parent bbb88dc commit f5aad0b
Show file tree
Hide file tree
Showing 266 changed files with 3,640 additions and 1,599 deletions.
5 changes: 5 additions & 0 deletions .idea/.gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions .idea/modules.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions .idea/swiftwave.org.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions .idea/vcs.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 0 additions & 9 deletions blog/2020-05-28-intro.md

This file was deleted.

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 @@
---
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 @@
---
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 @@
---
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**](./enable)
- [**swiftwave auto-update disable**](./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 @@
---
id: localregistry
title: swiftwave localregistry
tags:
- CLI
- Local Image Registry
sidebar_position: 10
---

Manage local local image registry

### Check available commands
- [**swiftwave localregistry start**](./start)
- [**swiftwave localregistry stop**](./stop)
- [**swiftwave localregistry restart**](./restart)
- [**swiftwave localregistry status**](./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 @@
---
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 @@
---
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 @@
---
id: status
title: swiftwave localregistry status
tags:
- CLI
- Local Image Registry
sidebar_position: 4
---

Check status of local image registry

### Usage

```
swiftwave localregistry status
```
Loading

0 comments on commit f5aad0b

Please sign in to comment.