You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/Authelia.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
How to setup SilverBullet with Authelia
2
2
3
-
In order for SilverBullet to work as intended, some files will need to be excluded from your authentication method of choice. These files need to always be accessible, for example for offline or [[PWA]] support.
3
+
For SilverBullet to work as intended, some files will need to be excluded from your authentication method of choice. These files always need to be accessible, for example for offline or [[PWA]] support.
Will let `pete` authenticate with password `1234`.
13
13
14
14
## Multiple users
15
-
Although multi-user support is still rudimentary, it is possible to have multiple users authenticate. These users can be configured using an JSON authentication file that SB can generate for you. It is usually named `.auth.json`.
15
+
Although multi-user support is still rudimentary, it is possible to have multiple users authenticate. These users can be configured using a JSON authentication file that SB can generate for you. It is usually named `.auth.json`.
16
16
17
17
You can enable authentication as follows:
18
18
19
19
```shell
20
20
silverbullet --auth /path/to/.auth.json
21
21
```
22
22
23
-
To create and manage an `.auth.json` file you can use the following commands:
23
+
To create and manage an `.auth.json` file, you can use the following commands:
24
24
25
25
*`silverbullet user:add --auth /path/to/.auth.json [username]` to add a user
26
26
*`silverbullet user:delete --auth /path/to/.auth.json [username]` to delete a user
@@ -31,7 +31,7 @@ If the `.auth.json` file does not yet exist, it will be created.
31
31
When SB is run with a `--auth` flag, this fill will automatically be reloaded upon change.
32
32
33
33
### Group management
34
-
While this functionality is not yet used, users can also be added to groups, which can be arbitrarily named. Likely the `admin` group will have special meaning down the line.
34
+
While this functionality is not yet used, users can also be added to groups which can be arbitrarily named. The `admin` group will likely have a special meaning down the line.
35
35
36
36
When adding a user, you can add one more `-G` or `--group` flags:
Copy file name to clipboardExpand all lines: website/Client Modes.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ SilverBullet currently supports two modes for its client (the part of SilverBull
5
5
6
6
You can toggle between these two modes by toggling the 🔄 button in the top bar.
7
7
8
-
You can switch modes any time, and use different modes on different devices.
8
+
You can switch modes any time and use different modes on different devices.
9
9
10
10
**Note:** It is technically possible to _switch off online mode_ (and allow synced mode only) by running the SilverBullet server with the `--sync-only` flag (or setting the `SB_SYNC_ONLY` environment variable to something). With this flag on, the sync button will not appear in the UI.
11
11
@@ -14,11 +14,11 @@ In online mode, all content in your space is kept on the server, and a lot of th
14
14
15
15
Advantages:
16
16
***Keeps content on the server**: this mode does not synchronize all your content to your client (browser), making this a better fit for large spaces or for cases where you only need to quickly login to SilverBullet to check something, e.g. on a device you don’t usually use. This use case is the reason why this is the default mode.
17
-
***Lighter-weight** in terms of memory and CPU use of the client.
17
+
***Lighterweight** in terms of memory and CPU use of the client.
18
18
19
19
Disadvantages:
20
-
***Requires a working network connection** to the server. You can not load pages, nor successfully persist changes without it.
21
-
***Higher latency**, since more interactions require calls to the server, this may be notable e.g., when completing page names.
20
+
***Requires a working network connection** to the server. You can not load pages nor successfully persist changes without it.
21
+
***Higher latency** since more interactions require calls to the server, this may be notable e.g., when completing page names.
22
22
23
23
## Synced mode
24
24
In this mode, all content is synchronized to the client, and all processing happens there. The server effectively acts as a “dumb data store.” All SilverBullet functionality is available even when there is no network connection available.
Copy file name to clipboardExpand all lines: website/Frontmatter.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
Frontmatter is a common format to attach additional metadata (data about data) to markdown documents.
2
2
3
-
In SilverBullet there are multiple ways to attach [[Metadata]] to a page, frontmatter is one of them.
3
+
In SilverBullet, there are multiple ways to attach [[Metadata]] to a page; frontmatter is one of them.
4
4
5
5
You create it by starting your markdown document with `---` followed by [[YAML]] encoded attributes and then ending with `---` again. Followed by the regular body of your document.
6
6
@@ -18,6 +18,6 @@ Here is an example:
18
18
SilverBullet allows arbitrary metadata to be added to pages this way, with two exceptions:
19
19
20
20
*`name` is an attribute used for page names, so don’t attempt to override it in frontmatter
21
-
*`tags` can be specified (as in the example) and are in effect another way of adding tags to your page, you can achieve the same result by simply adding hashtags in the body of your document, e.g. `#tag1 #tag2`.
21
+
*`tags` can be specified (as in the example) and are, in effect, another way of adding tags to your page. You can achieve the same result by simply adding hashtags in the body of your document, e.g. `#tag1 #tag2`.
22
22
23
23
SilverBullet also has the _convention_ of using attributes starting with a `$` for internal use. For instance, the sharing capability uses the `$share` attribute, and `$disableDirectives: true` has the special meaning of disabling [[🔌 Directive]] processing on a page.
Copy file name to clipboardExpand all lines: website/Guide/Deployment/Cloudflare and Portainer.md
+25-25Lines changed: 25 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,17 @@
1
1
In this guide we will show you how to deploy silverbullet and cloudflare in containers, making them "talk/communicate" in the same private network just for them.
2
2
3
-
This guide assumes that you have already deployed Portainer, if not, see [this official guide](https://docs.portainer.io/start/install-ce/server/docker/linux) from Portainer to deploy it on Linux.
3
+
This guide assumes that you have already deployed Portainer. If not, see [this official guide](https://docs.portainer.io/start/install-ce/server/docker/linux) from Portainer to deploy it on Linux.
4
4
5
5
### Brief
6
6
7
7
This guide will be divided into three parts, in the first we'll set up Silverbullet with Cloudflare. In the second, we will set up Cloudflare from the beginning to access Silverbullet from outside our LAN using [Tunnels](https://www.cloudflare.com/products/tunnel/). And in the third step, we protect our Silverbullet instance with [Access Zero Trust](https://www.cloudflare.com/products/zero-trust/access/) for authentication.
8
8
9
-
# 1 - Deploy Silverbullet and Clouflare in Portainer
9
+
# 1 - Deploy Silverbullet and Cloudflare in Portainer
10
10
11
11
## Prepare the Template
12
-
We will prepare a template in Portainer where we will add the configuration of a ==docker-compose.yaml== that will run our containers and we will be able to move the stack to another server/host if necessary using the same configuration.
12
+
We will prepare a template in Portainer where we will add the configuration of a ==docker-compose.yaml== that will run our containers, and we will be able to move the stack to another server/host if necessary using the same configuration.
13
13
14
-
First go to **Home** > (Your environment name, default is **local**) > **App Templates** > **Custom Templates** and click on the blue button in the right corner > "**Add Custom Template**".
14
+
First, go to **Home** > (Your environment name, default is **local**) > **App Templates** > **Custom Templates** and click on the blue button in the right corner > "**Add Custom Template**".
In a Web Browser in your Local Network (if your server is in your LAN) write the ip address of your server and add the port 3000 at the end, like this:
120
+
In a web browser in your local network (if your server is in your LAN) write the IP address of your server and add the port 3000 at the end, like this:
121
121
``http://your-ip-address:3000 ``
122
122
123
-
Right now the conecttion to silverbullet is **HTTP** and PWA([Progressive Web Apps](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps)) an offline mode will not work yet, don’t worry we will get into that later, but for now it should be working correctly, try to type something and sync it to your server.
123
+
Right now the connection to silverbullet is **HTTP** and PWA([Progressive Web Apps](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps)) and offline mode will not work yet. Don’t worry we will get into that later, but for now, it should be working correctly. Try to type something and sync it to your server.
124
124
125
125
---
126
126
127
-
# 2 - Setup Cloudflare with Tunnels.
127
+
# 2 - Set up Cloudflare with Tunnels.
128
128
129
-
Now we are going to use Cloudflare to be able to connect to SilverBullet from outside our network and have a valid SSL certificate without opening any ports or needing a static ipv4 address from our ISP or changing our router configuration.
129
+
Now we are going to use Cloudflare to be able to connect to SilverBullet from outside our network and have a valid SSL certificate without opening any ports or needing a static IPv4 address from our ISP or changing our router configuration.
130
130
131
131
You will need three things:
132
132
133
133
* An account with Cloudflare ☁️.
134
134
* A debit/credit card 💳.
135
-
* A domain name (you can buy it on [Njalla](https://njal.la/) 😉, your real name will not be shown if someone uses whois tools).
135
+
* A domain name (you can buy it on [Njalla](https://njal.la/) 😉. Your real name will not be shown if someone uses whois tools).
136
136
137
-
We assume you've already [signed up to Cloudflare](https://www.cloudflare.com/), if not you can go and do it now, it's free but you'll need to add a real debit/credit card to have access to the tunnels and zero access. If you don't want to do that, you can use **alternatives** like [Caddy](https://caddyserver.com/docs/quick-starts/reverse-proxy) or [Nginx](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) for reverse proxy and [Authelia](https://www.authelia.com/) or you can use the [basic authentication built-in](https://silverbullet.md/Authentication) for authentication.
137
+
We assume you've already [signed up to Cloudflare](https://www.cloudflare.com/), if not you can go and do it now. It's free but you'll need to add a real debit/credit card to have access to the tunnels and zero access. If you don't want to do that, you can use **alternatives** like [Caddy](https://caddyserver.com/docs/quick-starts/reverse-proxy) or [Nginx](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) for reverse proxy and [Authelia](https://www.authelia.com/) or you can use the [basic authentication built-in](https://silverbullet.md/Authentication) for authentication.
138
138
139
139
## Add your Site/Domain Name to Cloudflare
140
140
@@ -151,15 +151,15 @@ Click on **Zero Trust** once you have added your site/domain name.
Since we have already set up a container of cloudflare, just copy the token you are given. And be careful, if someone gets your token will be able to make a tunnel connection to your server.
157
+
Since we have already set up a container of Cloudflare, just copy the token you are given. And be careful, if someone gets your token they will be able to make a tunnel connection to your server.
Check now with **silberbullet.your-domain-name.com**. You should be able to access it.
186
186
187
-
# 3 - Setup Cloudflare Zero Access Trust (Auth).
187
+
# 3 - Set up Cloudflare Zero Access Trust (Auth).
188
188
189
189
We assume you've already [signed up to Cloudflare](https://www.cloudflare.com/), if not you can go and do it now, it's free but you'll need to add a real debit/credit card to have access to the tunnels and zero access. If you don't want to do that, you can use **alternatives** like [Caddy](https://caddyserver.com/docs/quick-starts/reverse-proxy) or [Nginx](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) for reverse proxy and [Authelia](https://www.authelia.com/) or you can use the [BasicAuth build-in](https://silverbullet.md/Authentication) for authentication.
190
190
@@ -199,21 +199,21 @@ Leave the rest of the page as default and click **Next** at the bottom of the pa
199
199
200
200
Now it's time to select the name of the policy, the action and the duration of the session.
201
201
202
-
Select a descriptive **Name** for future troubleshooting, select **Allow** for the **Action** and leave the session duration by default.
202
+
Select a descriptive **Name** for future troubleshooting, select **Allow** for the **Action** and leave the session duration at its default.
203
203
204
-
In the **Configure rules** section, select **Emails** if you want to use emails (or you can use range of IPs, specific countries...) for verification, and enter the emails you want to allow access to Silverbullet.
204
+
In the **Configure rules** section, select **Emails** if you want to use emails (or you can use a range of IPs, specific countries...) for verification, and enter the emails you want to allow access to Silverbullet.
Going back to the Zero Trust overview, we are now going to create some special rules to allow some specific files from silverbullet without authentication. The same thing happens with other auth applications such as [Authelia](https://silverbullet.md/Authelia).
213
213
214
214
Create a new self-hosted application in Cloudflare, we suggest the name **silverbullet bypass**.
215
215
216
-
And add the followings **pahts**:
216
+
And add the following **paths**:
217
217
218
218
```
219
219
.client/manifest.json
@@ -223,16 +223,16 @@ service_worker.js
223
223
224
224
Leave the rest as default and click **Next** at the bottom of the page.
For the policy name we suggest **silverbullet bypass paths**, as for the **Action** you need to select **Bypass** and in the Configure Rules **Select****Everyone** or you can exclude a range of IP's or countries if required.
226
+
For the policy name we suggest **silverbullet bypass paths**, as for the **Action** you need to select **Bypass**, and in the Configure Rules **Select****Everyone** or you can exclude a range of IP's or countries if required.
227
227
228
228
Leave the rest as default and click **Next** at the bottom of the page.
These rules only take affect on the specific paths, you can read more about [Policy inheritance on Cloudflare.](https://developers.cloudflare.com/cloudflare-one/policies/access/app-paths/)
230
+
These rules only take effect on the specific paths, you can read more about [Policy inheritance on Cloudflare.](https://developers.cloudflare.com/cloudflare-one/policies/access/app-paths/)
231
231
232
232
On the next page, leave everything as default and click on **Add Application** at the bottom of the page.
233
233
234
234
Go and check your **silberbullet.your-domain-name.com** everything should be working correctly.
235
235
236
-
Right now the conecttion to silverbullet is **HTTPS** and PWA ([Progressive Web Apps](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps)) an offline mode will work now.
236
+
Now the connection to silverbullet is **HTTPS** and PWA ([Progressive Web Apps](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps)) and offline mode will work.
0 commit comments