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

feat: freeze v1.x.x docs and init v2.0.x #42

Merged
merged 2 commits into from
May 23, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Built on robust foundations:
Experience the ease of deployment and management with SwiftWave! 🌊

### 🏰 System Architecture Overview
![Architecture](/img/architecture.gif)
<img src="/img/architecture.gif" />

### 🚀 Deployment Options
- **Source Freedom**: Deploy your app from any git source (Github, Gitlab, etc.) 🌐 (Supports public and private repositories)
Expand Down
17 changes: 17 additions & 0 deletions versioned_docs/version-1.x.x/cli/auto-updater/disable.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: disable
title: swiftwave auto-updater disable
tags:
- CLI
- Auto Updater
sidebar_position: 2
---

Disable Swiftwave Auto Updater Service.


### Usage

```
swiftwave auto-updater disable
```
25 changes: 25 additions & 0 deletions versioned_docs/version-1.x.x/cli/auto-updater/enable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---

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: enable
title: swiftwave auto-updater enable
tags:
- CLI
- Auto Updater
sidebar_position: 1
---

Enable Swiftwave Auto Updater Service.
> Note: It will check for updates every 5 minutes to apply minor version updates and hotfixes to keep SwiftWave up to date and secure.

### Pre-requisites
You should keep automated database migration enabled to avoid any issues and use SwiftWave Auto Updater.

If you have disabled automated database migration, you can enable it by
- Run `swiftwave config -e vim` or `swiftwave config -e nano` to open SwiftWave configuration file in editor. [See more](/docs/cli/config)
- Set `service.auto_migrate_database` to `false`
- Save and close the file

### Usage

```
swiftwave auto-updater enable
```
14 changes: 14 additions & 0 deletions versioned_docs/version-1.x.x/cli/auto-updater/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---

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: auto-updater
title: swiftwave auto-updater
tags:
- CLI
- Auto Updater
sidebar_position: 14
---

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

### Check available commands
- [**swiftwave auto-updater enable**](/docs/cli/auto-updater/enable)
- [**swiftwave auto-updater disable**](/docs/cli/auto-updater/disable)
21 changes: 21 additions & 0 deletions versioned_docs/version-1.x.x/cli/config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
tanmoysrt marked this conversation as resolved.
Show resolved Hide resolved
id: config
title: swiftwave config
tags:
- CLI
sidebar_position: 3
---

Open SwiftWave configuration file in editor

### Usage

```
swiftwave config [flags]
```

### Flags

| Flag | Type | Default | Mandatory | Description |
|----------|---------------------|---------|---------------------|-----------------------------------|
| --editor | string (vi, vim, nano, gedit, etc.) | dependent on system | <center>✅</center> | Editor to use for edit config file |
23 changes: 23 additions & 0 deletions versioned_docs/version-1.x.x/cli/create-user.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
tanmoysrt marked this conversation as resolved.
Show resolved Hide resolved
id: create-user
title: swiftwave create-user
tags:
- CLI
sidebar_position: 6
---

Create a new user

### Usage

```
swiftwave create-user [flags]
```

### Flags


| Flag | Type | Default | Mandatory | Description |
|--------|------------------|---------|---------------------|-----------------------------------|
| --username | string | <center>--</center> | <center>✅</center> | Username for new admin user |
| --password | string | <center>--</center> | <center>✅</center> | Password for new admin user |
15 changes: 15 additions & 0 deletions versioned_docs/version-1.x.x/cli/db-migrate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---

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: db-migrate
title: swiftwave db-migrate
tags:
- CLI
sidebar_position: 5
---

Migrate new database changes to the database.

### Usage

```
swiftwave db-migrate
```
16 changes: 16 additions & 0 deletions versioned_docs/version-1.x.x/cli/delete-user.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: delete-user
title: swiftwave delete-user
tags:
- CLI
sidebar_position: 7
---

Delete a user

### Usage


```
swiftwave delete-user --username <username of user to delete>
```
15 changes: 15 additions & 0 deletions versioned_docs/version-1.x.x/cli/haproxy/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---

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: swiftwave-haproxy
title: swiftwave haproxy
tags:
- CLI
- HAProxy
sidebar_position: 11
---

Manage HAProxy service

### Check available commands
- [**swiftwave haproxy start**](/docs/cli/haproxy/start)
- [**swiftwave haproxy stop**](/docs/cli/haproxy/stop)
- [**swiftwave haproxy status**](/docs/cli/haproxy/status)
16 changes: 16 additions & 0 deletions versioned_docs/version-1.x.x/cli/haproxy/start.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: start
title: swiftwave haproxy start
tags:
- CLI
- HAProxy
sidebar_position: 1
---

Start HAProxy service

### Usage

```
swiftwave haproxy start
```
16 changes: 16 additions & 0 deletions versioned_docs/version-1.x.x/cli/haproxy/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 haproxy status
tags:
- CLI
- HAProxy
sidebar_position: 3
---

Show HAProxy service status

### Usage

```
swiftwave haproxy status
```
17 changes: 17 additions & 0 deletions versioned_docs/version-1.x.x/cli/haproxy/stop.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: stop
title: swiftwave haproxy stop
tags:
- CLI
- HAProxy
sidebar_position: 2
---

Stop HAProxy service

### Usage

```
swiftwave haproxy stop
```

27 changes: 27 additions & 0 deletions versioned_docs/version-1.x.x/cli/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---

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: cli
title: 💻 CLI Reference
tags:
- CLI
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 |
17 changes: 17 additions & 0 deletions versioned_docs/version-1.x.x/cli/info.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: info
title: swiftwave info
tags:
- CLI
sidebar_position: 15
---

Print info of current Swiftwave installation

### Usage

```
swiftwave info
```


27 changes: 27 additions & 0 deletions versioned_docs/version-1.x.x/cli/init.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---

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: init
title: swiftwave init
tags:
- CLI
sidebar_position: 2
---

Initialize the configuration for Swiftwave on the system.

### Usage

```
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 |
15 changes: 15 additions & 0 deletions versioned_docs/version-1.x.x/cli/postgres/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---

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: swiftwave-postgres
title: swiftwave postgres
tags:
- CLI
- Database
sidebar_position: 12
---

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

### Check available commands
- [**swiftwave postgres start**](/docs/cli/postgres/start)
- [**swiftwave postgres stop**](/docs/cli/postgres/stop)
- [**swiftwave postgres status**](/docs/cli/postgres/status)
17 changes: 17 additions & 0 deletions versioned_docs/version-1.x.x/cli/postgres/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 postgres start
tags:
- CLI
- Database
sidebar_position: 1
---


Start local postgres database (Recommended only for standalone installations)

### Usage

```
swiftwave postgres start
```
16 changes: 16 additions & 0 deletions versioned_docs/version-1.x.x/cli/postgres/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 postgres status
tags:
- CLI
- Database
sidebar_position: 3
---

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

### Usage

```
swiftwave postgres status
```
16 changes: 16 additions & 0 deletions versioned_docs/version-1.x.x/cli/postgres/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 postgres stop
tags:
- CLI
- Database
sidebar_position: 2
---

Stop local postgres database (Recommended only for standalone installations)

### Usage

```
swiftwave postgres stop
```
16 changes: 16 additions & 0 deletions versioned_docs/version-1.x.x/cli/service/disable.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: disable
title: swiftwave service disable
tags:
- CLI
- Swiftwave Service
sidebar_position: 2
---

Disable Swiftwave daemon service

### Usage

```
swiftwave service disable
```
16 changes: 16 additions & 0 deletions versioned_docs/version-1.x.x/cli/service/enable.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: enable
title: swiftwave service enable
tags:
- CLI
- Swiftwave Service
sidebar_position: 1
---

Enable Swiftwave daemon service

### Usage

```
swiftwave service enable
```
Loading
Loading