Skip to content

Commit 32b39bf

Browse files
committed
Add updates for v0.6.3
1 parent 9dfa638 commit 32b39bf

File tree

3 files changed

+19
-3
lines changed

3 files changed

+19
-3
lines changed

docs/5.cfg-files.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ A configuration file is a TOML file, which has the following basic structure:
1414
host = "127.0.0.1"
1515
port = 2003
1616
noart = false # optional
17+
maxcon = 50000 # optional
1718

1819
[bgsave]
1920
enabled = true
@@ -27,6 +28,7 @@ advanced configuration:
2728
- `host` : This is the IP address to which you want the database server to bind to. It can be any valid IPv4 _or_ IPv6 address, as a quoted string
2829
- `port` : This is the port to which you want Sky to bind to
2930
- `noart`: This is **an optional argument** and is recommended for secure environments where displaying terminal artwork might cause problems
31+
- `maxcon` : Set the maximum number of clients that can query concurrently
3032
- `bgsave`:
3133
- `enabled`: This is an optional key, which is to be set to true to enable BGSAVE or false to disable it. If this key is not specified, Sky will enable BGSAVE by default
3234
- `every` : Run BGSAVE `every` seconds. So, for example, if you set this to 120, BGSAVE will run every two minutes. This is also an optional key, and if you don't provide it, the default BGSAVE duration of 120 seconds is used

docs/deployment-notes.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,12 @@ Here are some _good to know_ things about deploying Skytable:
99
- The daemon will create a `.sky_pid` file in its working directory which functions as a PID file
1010
and indicates other processes to not use the data directory. If the daemon is somehow forcefully
1111
stopped, the file may not be removed. In that case, you should manually remove the file
12-
- Skytable currently has a hardcoded limit of 50000 connections on a single daemon instance. This limit will be user accessible in the (near) future
12+
- Skytable currently has a default limit of 50000 connections on a single daemon instance. This limit
13+
can be modified by setting the `maxcon` in the [configuration file](config-files).
14+
:::note
15+
Make sure you change `maxcon` according to the available system resources to avoid attacks
16+
that may cause your system to crash
17+
:::
1318
- Skytable is inherently multithreaded. As of now, there is no way to stop Skytable from using
1419
multiple threads
1520
- The best way to deploy Skytable is as a service (and passing `--noart` to avoid terminal artwork

docs/ssl.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Skytable lets you secure connections with TLS/SSL. This feature is built into Sk
88

99
This is outside the scope of this document, but you can read [this guide on Stackoverflow](https://stackoverflow.com/a/10176685) to get a brief idea of creating one.
1010

11-
### Step 2: Add this to your configuration and launch
11+
### Step 2: Add it to your configuration and launch
1212

1313
#### With config files
1414
Add the following block:
@@ -30,4 +30,13 @@ skyd -z cert.pem -k key.pem
3030
```
3131
:::tip Tip
3232
You can pass the `--sslonly` flag to force the server to only accept secure connections, disabling the non-SSL interface. When this flag is not passed, and other SSL options are given — the server listens to both SSL and non-SSL requests
33-
:::
33+
:::
34+
35+
:::info Note
36+
To use TLS with the Skytable shell (`skysh`) just run:
37+
```
38+
skysh -C /path/to/cert.pem --port [SSLPORT]
39+
```
40+
and you'll be on a secure connection. Don't forget the SSL port! The skytable daemon binds the secure
41+
listener on a different port when in multi-socket mode.
42+
:::

0 commit comments

Comments
 (0)