Skip to content

Commit 0efd572

Browse files
authored
Merge pull request #200 from HOSTED-POWER/BjarneVO-KBrestructure
Bjarne vo k brestructure
2 parents ddf3c18 + 0fce0ac commit 0efd572

16 files changed

Lines changed: 71 additions & 71 deletions

TurboStack Platform/Hosts/Accounts/accountclone.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ icon: upload
55

66
# Cloning an account
77

8-
To make a clone of an existing application, we provide the **Clone Account** feature. This function replicates the entire configuration and copies the files and database, enabling a quick and efficient setup with minimal effort.
8+
To make a clone of an **existing application**, we provide the **Clone Account** feature. This function **replicates the entire configuration** and **copies the files and database**, enabling a quick and efficient setup with minimal effort.
99

1010
!!!Info
1111
This feature is extremely useful to quickly copy your production environment to a staging environment or vice versa!
@@ -26,6 +26,4 @@ Here’s how to do it:
2626
6. The server will now clone the account, indicated by the **publishing** indicator in the top left.
2727
![](../../../img/turbostackapp/newapp/publishing.png)
2828
7. If the account clone has succeeded, it will be indicated in the top right with a timestamp.
29-
![](../../../img/turbostackapp/newapp/publishsuccess.png)
30-
31-
And that’s it! Your application is now cloned to a new account. Be sure to save the configuration and publish it when you're ready.
29+
![](../../../img/turbostackapp/newapp/publishsuccess.png)

TurboStack Platform/Hosts/Accounts/credentials.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Make sure you have already created an existing user with a successful publish.
1111
!!!
1212

1313
You can fetch the credentials from the application you just created.
14-
To do this, click on the gear icon next to the user and navigate to the **Database Info** tab.
14+
To do this, click on the **gear icon** next to the user and navigate to the **Database Info** tab.
1515

1616
![](../../../img/turbostackapp/newapp/tsa_gearwheel.png)
1717
To get database credentials:

TurboStack Platform/Hosts/Accounts/databaseusers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ label: Extra database users
66

77
## Adding extra database users
88

9-
It is possible to add an additional database user with read-only or admin access to a databases. You can also retrieve the credentials for this user.
9+
It is possible to add an **additional database user** with **read-only** or **admin** access to a databases. You can also retrieve the **credentials** for this user.
1010
![](../../../img/turbostackapp/newapp/tsa_extra_db_user1.png)
1111
![](../../../img/turbostackapp/newapp/tsa_extra_db_user2.png)
1212
**admin**: Full access to ALL server databases.

TurboStack Platform/Hosts/Accounts/migrationhero.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ To simplify the migration of your external application to TurboStack, the **Migr
1212
If you want to migrate an application from TurboStack to TurboStack, please use the **Account Cloning** feature documented below.
1313
!!!
1414

15-
Before starting, make sure you have already created an application and successfully performed a **Save and Publish**.
15+
Before starting, make sure you have already **created an application** and successfully performed a **Save and Publish**.
1616

1717
1. Navigate to the **Accounts** tab in the TurboStack Platform under your host.
1818
![](../../../img/turbostackapp/newapp/tsa_user6.png)
1919

2020
2. Click **Migration Hero**.
2121
![](../../../img/turbostackapp/newapp/tsa_migration_hero1.png)
2222

23-
3. In the next step, enter the remote host and the user you want to migrate.
23+
3. In the next step, enter the **remote host** and the **user** you want to migrate.
2424
Then, choose the authentication method you want to use to connect to the remote host.
2525
![](../../../img/turbostackapp/newapp/tsa_migration_hero2.png)
2626

@@ -30,10 +30,10 @@ Then, choose the authentication method you want to use to connect to the remote
3030
5. **Option 2:** Generate and add the provided public SSH key to the `.ssh/authorized_keys` file on the remote host, then click **Next**.
3131
![](../../../img/turbostackapp/newapp/tsa_migration_hero4.png)
3232

33-
6. Choose the destination account (it must be an existing one) and select whether to migrate the database, files, or both. Then click **Next**.
33+
6. Choose the **destination account** (it must be an existing one) and select whether to **migrate the database, files, or both**. Then click **Next**.
3434
![](../../../img/turbostackapp/newapp/tsa_migration_hero5.png)
3535

36-
7. Select the hostname(s) you want to associate with the account and choose the type of certificate to activate. Click **Start Import** to begin the migration.
36+
7. Select the **hostname(s)** you want to associate with the account and choose the **type of certificate** to generate. Click **Start Import** to begin the migration.
3737
![](../../../img/turbostackapp/newapp/tsa_migration_hero6.png)
3838

3939
8. A migration progress popup will appear in the bottom-right corner. Once it finishes, your migration is complete.

TurboStack Platform/Hosts/Accounts/setup.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ icon: plus-circle
44
---
55
# Setup
66

7-
This article explains how to set up your application environment from scratch. If you want to replicate an existing environment, or want to migrate an application from an external server to TurboStack, please consult the [Account Cloning](accountclone.md) and [Migration Hero](migrationhero.md) articles respectively.
7+
This article explains how to set up your application environment from scratch. If you want to **replicate an existing environment**, or want to **migrate an application from an external server to TurboStack**, please consult the [Account Cloning](accountclone.md) and [Migration Hero](migrationhero.md) articles respectively.
88

99
!!! info
10-
New servers can also be auto-configured using **Templates**! Visit [this](../../templates.md) page for more information.
10+
New servers can also be autoconfigured using **Templates**! Visit [this](../../templates.md) page for more information.
1111
!!!
1212

1313
## What is an account and what is it used for?
1414

15-
The account is a linux user which can be used simply to access the server. However, you probably want to deploy one or multiple **applications** under this user. This guide will explain how to deploy system users and all settings your application requires.
15+
The account is a **Linux user** which can be used simply to access the server. However, you probably want to deploy one or multiple **applications** under this user. This guide will explain how to deploy system users and all settings your application requires.
1616

1717
!!!
1818
For staging and production instances of an application, best practice is always to use an entirely different server, because it's by design unavoidable that resources allocated for staging, will be (silently) "taken away" from production. Even when this staging application is rarely used, it would still consume memory for e.g. databases, causing avoidable overhead.
@@ -37,7 +37,7 @@ Creating a new user on the [TurboStack Platform](https://my.turbostack.app "Turb
3737
![](../../../img/turbostackapp/newapp/tsa_user4.png)
3838
### Deploying a new account in the source YAML [!badge icon="alert" text="Advanced"]
3939

40-
Advanced users can also deploy an account in the source YAML:
40+
Advanced users can also deploy an account in the **source YAML**
4141

4242
```yaml
4343
system_users:
@@ -46,7 +46,7 @@ system_users:
4646
4747
![](../../../img/turbostackapp/newapp/tsa_user5.png)
4848
49-
More info on using the YAML editor can be found [here](../yaml.md).
49+
More info on using the **YAML editor** can be found [here](../yaml.md).
5050
5151
## Creating a new application
5252
@@ -113,6 +113,6 @@ system_users:
113113
114114
![](../../../img/turbostackapp/newapp/tsa_app11.png)
115115
116-
More info on using the YAML editor can be found [here](../yaml.md).
116+
More info on using the **YAML editor** can be found [here](../yaml.md).
117117
118118

TurboStack Platform/Hosts/advancedtab.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,20 @@ The **advanced** tab offers some more advanced configuration options for specifi
1515

1616
**DKIM (DomainKeys Identified Mail)** is an email authentication method that helps prevent email spoofing. It works by adding a **digital signature** to outgoing messages, which receiving mail servers can verify using the **public key** published in the sender’s domain DNS records. This sections allows you to easily set up DKIM for your mail domain.
1717

18-
1. Fill in the FQDN (Fully Qualified Domain Name), which is the domain you want to mail from.
19-
2. Choose a selector for the DKIM record. This selector will be used as the subdomain part of the record.
20-
3. SSH to the server and use the command `tscli dkim records` to acquire your DKIM record.
21-
4. Create the DKIM record in your domain's DNS settings
22-
5. SSH to the server and use the command `tscli dkim validate` to check if the DNS record was created correctly.
18+
1. Fill in the **FQDN (Fully Qualified Domain Name)**, which is the domain you want to mail from.
19+
2. Choose a **selector** for the DKIM record. This selector will be used as the **subdomain** part of the record.
20+
3. SSH to the server and use the command `tscli dkim records` to **acquire your DKIM record**.
21+
4. **Create the DKIM record** in your domain's DNS settings
22+
5. SSH to the server and use the command `tscli dkim validate` to check if the **DNS record was created correctly**.
2323
6. All done!
2424

2525
!!! info
26-
DKIM is part of your domain's mail deliverability optimisation. For more information on mail deliverability, take a look [here](../../Configuration/Mail/deliverability.md).
26+
DKIM is part of your domain's mail **deliverability** optimisation. For more information on mail deliverability, take a look [here](../../Configuration/Mail/deliverability.md).
2727
!!!
2828

2929
### Mail Devtool - Enabling mail capturing and mail testing
3030

31-
TurboStack allows you to use either Mailpit or Mailhog to test your mailing. Once activated, you can reach the GUI through the URLs https://<hostname>/mailpit or https://<hostname>/mailhog respectively. Here, a basic auth prompt will appear, where you can enter the [system user's credentials](Accounts/credentials.md).
31+
TurboStack allows you to use either **Mailpit** or **Mailhog** to test your mailing. Once activated, you can reach the GUI through the URLs https://<hostname>/mailpit or https://<hostname>/mailhog respectively. Here, a basic auth prompt will appear, where you can enter the [system user's credentials](Accounts/credentials.md).
3232

3333
!!! info
3434
We currently recommend Mailpit over Mailhog, as the Mailhog project is no longer receiving updates.
@@ -40,23 +40,23 @@ We currently recommend Mailpit over Mailhog, as the Mailhog project is no longer
4040

4141
### Varnish Cache Size
4242

43-
This value determines the amount of memory that can be used by Varnish to store cached content. The default setting auto-scales based on your server flavour, but can be set to a size of your preference.
43+
This value determines the **amount of memory** that can be used by Varnish to store cached content. The default setting **auto-scales** based on your server flavour, but can be set to a size of your preference.
4444

4545
### Use your own Varnish custom VCL
4646

47-
Your Varnish is set up to use a default VCL (Varnish Configuration Language) based on and optimised for your selected app_type. However, you can use your own VCL if you wish. To do so, toggle this option on and add your VCL file to the directory /etc/varnish/conf.d/ on your server.
47+
Your Varnish is set up to use a **default VCL** (Varnish Configuration Language) based on and optimised for your selected **app type**. However, you can use your own VCL if you wish. To do so, toggle this option on and add your VCL file to the directory `/etc/varnish/conf.d/` on your server.
4848

4949
### Varnish Flavor
5050

51-
Choose between the Open Source and Enterprise versions of Varnish. The Open Source flavor is free, while the Enterprise version requires you to buy a seperate license.
51+
Choose between the **Open Source** and **Enterprise** versions of Varnish. The Open Source flavor is free, while the Enterprise version requires you to buy a **separate license**.
5252

53-
The Open Source flavor includes an option to enable Varnish modules.
53+
The Open Source flavor includes an option to **enable Varnish modules**.
5454

5555
## RabbitMQ Options
5656

5757
![RabbitMQ Options](img/advancedtabrabbitmq.png)
5858

59-
The RabbitMQ Plugins options allows you to easily install RabbitMQ plugins.
59+
The RabbitMQ Plugins options allows you to easily **install RabbitMQ plugins**.
6060

6161
## FTP Server Options
6262

@@ -68,26 +68,26 @@ Generate an SSL certificate for FTP connections using a hostname of your choice.
6868

6969
### Enable SFTP for FTP Users
7070

71-
Enables SFTP connections over port 222 using the existing FTP daemon and users. This does not work over port 22, as this is reserved for the SSH service.
71+
Enables SFTP connections over **port 222** using the existing FTP daemon and users. This does not work over port 22, as this is reserved for the SSH service.
7272

7373
## Operating System
7474

7575
![Operating System](img/advancedtaboperatingsystem.png)
7676

7777
### OS Extra Packages
7878

79-
A non-exhaustive list of packages to be installed. Please note this list is not complete, and more options are available when using source YAML mode! More info on editing YAML can be found [here](yaml.md)
79+
A non-exhaustive list of packages to install. Please note this list is not complete, and more options are available when using source YAML mode! More info on editing YAML can be found [here](yaml.md)
8080

8181
### Maintenance Window
8282

83-
Set a maintenance window for patches and updates that require rebooting the server. This allows you to choose your least critical timing for this essential maintenance.
83+
Set a maintenance window for **patches and updates** that require rebooting the server. This allows you to choose your **least critical timing** for essential updates.
8484

8585
## Advanced Database Monitoring
8686

8787
![img.png](img/advancedtabdatabasemonitoring.png)
8888

89-
Allows you to set up the database monitoring tool PMM (Percona Monitoring and Management) on your TurboStack.
89+
Allows you to set up the database monitoring tool **PMM (Percona Monitoring and Management)** on your TurboStack.
9090

91-
If you have a pmm advanced database analytics system, you can fill in the PMM master server's hostname to link your TurboStack server to it. The PMM Sampling Rate can be set in Advanced Settings.
91+
If you have a PMM advanced database analytics system, you can fill in the **PMM master server's hostname** to link your TurboStack server to it. The **PMM Sampling Rate** can be set in Advanced Settings.
9292

9393
More information on PMM can be found [here](https://docs.percona.com/percona-monitoring-and-management/3/index.html).

TurboStack Platform/Hosts/general.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Before we get down to the details, let's look into some general functionality:
1313

1414
#### 1. Switch between the GUI layout and the (advanced) YAML layout
1515

16-
You can deploy your server using the GUI, or if you're more of an infrastructure-as-code nerd, you can dive straight into the YAML. Any changes you make in either GUI or YAML will be reflected in the other, so feel free to try both!
16+
You can deploy your server using the **GUI**, or if you're more of an **infrastructure-as-code** nerd, you can dive straight into the **YAML**. Any changes you make in either GUI or YAML will be reflected in the other, so feel free to try both!
1717

1818
For more information on configuring your server using YAML, click [here](yaml.md).
1919

@@ -23,18 +23,18 @@ If you want to set YAML as default, you can do so by clicking the icon on the to
2323

2424
#### 2. Revisions: shows all historic configuration changes made to the server
2525

26-
We all make mistakes, but we have you covered: The revision function allows you to review the full history of server configuration changes and revert to a past version at the click of a button.
26+
We all make mistakes, but we have you covered: The **revision function** allows you to review the **full history** of server configuration changes and **revert to a past version** at the click of a button.
2727

2828
#### 3. Fetch the credentials and IPs of the server's users and databases
2929

30-
The credentials button gives you a full overview of all your server credentials, including system users, database users, FTP users, etc.
30+
The **Credentials** button gives you a full overview of all your server credentials, including system users, database users, FTP users, etc.
3131

3232
#### 4. Save any changes made to the configuration
3333

3434
Save your changes when settings have been modified, without deploying the changes to the server.
3535

3636
#### 5. Save and Publish: saves and deploys the changes made to the server
3737

38-
Save the changes you've made to the configuration, and immediately deploy them to the server. There is also an option to save & full publish, which will ensure everything is deployed, as opposed to only the changes.
38+
Save the changes you've made to the configuration, and immediately **deploy** them to the server. There is also an option to **save & full publish**, which will ensure **everything** is deployed, as opposed to only the changes.
3939

4040
The following pages describe configuration options for all tabs in the host management console.

TurboStack Platform/Hosts/groupstab.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ icon: people
55

66
# Groups tab
77

8-
Groups make it possible to apply certain settings across multiple TurboStack nodes, such as time zones or SSH key access.
8+
Groups make it possible to **apply certain settings across multiple TurboStack nodes**, such as time zones or SSH key access.
99

1010
![Groups Tab](img/groupstab.png)
1111

12-
This section of the Hosts management allows you to apply or remove Groups you have created separately to and from the current server. More info on what Groups are and how to manage them can be found [here](../groups.md).
12+
This section of the **Hosts** management allows you to apply or remove Groups you have created separately to and from the current server. More info on what Groups are and how to manage them can be found [here](../groups.md).

TurboStack Platform/Hosts/monitoring.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ icon: eye
44
---
55
# Monitoring
66

7-
Hosted Power proactively monitors your infrastructure to ensure server and service availability while simultaneously tracking resource usage. It alerts you if the load is too high, disk space is running low, or other critical thresholds are met, helping you maintain optimal performance.
7+
Hosted Power proactively **monitors your infrastructure** to ensure server and service **availability** while simultaneously tracking **resource usage**. It alerts you if the load is too high, disk space is running low, or other critical thresholds are met, helping you maintain optimal performance.
88

99
The general health of the server can be seen in the TurboStack Platform overview:
1010

@@ -15,12 +15,12 @@ The general health of the server can be seen in the TurboStack Platform overview
1515
3. CPU load and usage
1616
4. Disk usage
1717

18-
If any of these checks alert, the icons will become red. When this is the case, please contact the Hosted Power support asap.
18+
If any of these checks alert, the icons will become red. When this is the case, please contact the [Hosted Power Support](../../Support/standard_support.md) asap.
1919

2020
## Website monitoring URL
2121

22-
The TurboStack Platform is also able to monitor a website URL per application. In this case, the website URL will be added to our monitoring system
23-
and Hosted Power will monitor the availability of the website based on the URL, and intervene 24/7 if an issue arises.
22+
The [TurboStack Platform](https://my.turbostack.app/ "TurboStack Platform") is also able to **monitor a website URL** per application. In this case, the website URL will be added to our monitoring system
23+
and Hosted Power will **monitor the availability** of the website based on the URL, and **intervene 24/7** if an issue arises.
2424

2525
Please follow the instructions below to activate the monitoring url on your server
2626

0 commit comments

Comments
 (0)