-
Notifications
You must be signed in to change notification settings - Fork 6
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
id: disable | ||
title: swiftwave auto-updater disable | ||
tags: | ||
- CLI | ||
- Auto Updater | ||
sidebar_position: 2 | ||
--- | ||
|
||
Disable Swiftwave Auto Updater Service. | ||
|
||
|
||
### Usage | ||
|
||
``` | ||
swiftwave auto-updater disable | ||
``` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [LanguageTool] reported by reviewdog 🐶 |
||
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 | ||
``` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [LanguageTool] reported by reviewdog 🐶 |
||
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) |
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 | |
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 | |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [LanguageTool] reported by reviewdog 🐶 |
||
id: db-migrate | ||
title: swiftwave db-migrate | ||
tags: | ||
- CLI | ||
sidebar_position: 5 | ||
--- | ||
|
||
Migrate new database changes to the database. | ||
|
||
### Usage | ||
|
||
``` | ||
swiftwave db-migrate | ||
``` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [LanguageTool] reported by reviewdog 🐶 |
||
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> | ||
``` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [LanguageTool] reported by reviewdog 🐶 |
||
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) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [LanguageTool] reported by reviewdog 🐶 |
||
id: start | ||
title: swiftwave haproxy start | ||
tags: | ||
- CLI | ||
- HAProxy | ||
sidebar_position: 1 | ||
--- | ||
|
||
Start HAProxy service | ||
|
||
### Usage | ||
|
||
``` | ||
swiftwave haproxy start | ||
``` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [LanguageTool] reported by reviewdog 🐶 |
||
id: status | ||
title: swiftwave haproxy status | ||
tags: | ||
- CLI | ||
- HAProxy | ||
sidebar_position: 3 | ||
--- | ||
|
||
Show HAProxy service status | ||
|
||
### Usage | ||
|
||
``` | ||
swiftwave haproxy status | ||
``` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [LanguageTool] reported by reviewdog 🐶 |
||
id: stop | ||
title: swiftwave haproxy stop | ||
tags: | ||
- CLI | ||
- HAProxy | ||
sidebar_position: 2 | ||
--- | ||
|
||
Stop HAProxy service | ||
|
||
### Usage | ||
|
||
``` | ||
swiftwave haproxy stop | ||
``` | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [LanguageTool] reported by reviewdog 🐶 |
||
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 | |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [LanguageTool] reported by reviewdog 🐶 |
||
id: info | ||
title: swiftwave info | ||
tags: | ||
- CLI | ||
sidebar_position: 15 | ||
--- | ||
|
||
Print info of current Swiftwave installation | ||
|
||
### Usage | ||
|
||
``` | ||
swiftwave info | ||
``` | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [LanguageTool] reported by reviewdog 🐶 |
||
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 | |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [LanguageTool] reported by reviewdog 🐶 |
||
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) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [LanguageTool] reported by reviewdog 🐶 |
||
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 | ||
``` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [LanguageTool] reported by reviewdog 🐶 |
||
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 | ||
``` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [LanguageTool] reported by reviewdog 🐶 |
||
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 | ||
``` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [LanguageTool] reported by reviewdog 🐶 |
||
id: disable | ||
title: swiftwave service disable | ||
tags: | ||
- CLI | ||
- Swiftwave Service | ||
sidebar_position: 2 | ||
--- | ||
|
||
Disable Swiftwave daemon service | ||
|
||
### Usage | ||
|
||
``` | ||
swiftwave service disable | ||
``` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [LanguageTool] reported by reviewdog 🐶 |
||
id: enable | ||
title: swiftwave service enable | ||
tags: | ||
- CLI | ||
- Swiftwave Service | ||
sidebar_position: 1 | ||
--- | ||
|
||
Enable Swiftwave daemon service | ||
|
||
### Usage | ||
|
||
``` | ||
swiftwave service enable | ||
``` |
There was a problem hiding this comment.
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