diff --git a/docker-compose.yaml b/docker-compose.yaml deleted file mode 100644 index 8b46b173..00000000 --- a/docker-compose.yaml +++ /dev/null @@ -1,14 +0,0 @@ -services: - silverbullet: - image: zefhemel/silverbullet - container_name: silverbullet - restart: unless-stopped - ## To enable additional options, such as authentication, set environment variables, e.g. - #environment: - #- SB_USER=angel:1234 - volumes: - - space:/space - ports: - - ${PORT}:3000 -volumes: - space: diff --git a/website/Install/Local.md b/website/Install/Local.md index 017859a3..620aa485 100644 --- a/website/Install/Local.md +++ b/website/Install/Local.md @@ -1,18 +1,15 @@ -Let’s start with the simplest, local machine setup: - -## Local machine setup Installing SilverBullet as a (local) web server is pretty straightforward, if you’re comfortable with the terminal, at least. -The setup is simple: in a terminal run the silverbullet server process on your machine, then connect to it locally from your browser. +The basic setup is simple: in a terminal, run the silverbullet server process on your machine, then connect to it locally from your browser via localhost. You have two options here: -1. Installation via [Deno](https://deno.com/) (the awesome JavaScript runtime) -2. Installation via [Docker](https://www.docker.com/) (the awesome container runtime) +1. Installation via [[$deno|Deno]] (the awesome JavaScript runtime) +2. Installation via [[$docker|Docker]] (the awesome container runtime) -### Installation via Deno +# Installing using Deno $deno -This consists of two steps (unless Deno is already installed — in which case we’re down to one): +This consists of two steps (unless [Deno](https://deno.com/) is already installed — in which case we’re down to one): 1. [Install Deno](https://deno.land/manual/getting_started/installation) 2. Install SilverBullet itself (steps below) @@ -41,38 +38,43 @@ silverbullet By default, SilverBullet will bind to port `3000`; to use a different port, use the `-p` flag. -For security reasons, by default, SilverBullet only allows connections via `localhost` (or `127.0.0.1`). To also allow connections from the network, pass a `-L 0.0.0.0` flag (0.0.0.0 for all connections, or insert a specific address to limit the host), ideally combined with `--user username:password` to add simple password protection. +For security reasons, by default, SilverBullet only allows connections via `localhost` (or `127.0.0.1`). To also allow connections from the network, pass a `-L0.0.0.0` flag (0.0.0.0 for all connections, or insert a specific address to limit the host), combined with `--user username:password` to add simple [[Authentication]]. -Once downloaded and booted, SilverBullet will print out a URL to open SB in your browser. +Once downloaded and booted, SilverBullet will print out a URL to open in your browser. -#### Upgrading SilverBullet +## Upgrading SilverBullet SilverBullet is regularly updated. To get the latest and greatest, simply run: ```shell silverbullet upgrade ``` -And restart SilverBullet. You should be good to go. +And restart SilverBullet. You should be good to go. Also run -### Installing SilverBullet with Docker +```shell +deno upgrade +``` + +Regularly, to get the latest and greatest deno. + +# Installing using Docker $docker There is a [docker image on docker hub](https://hub.docker.com/r/zefhemel/silverbullet). The image comes in two flavors: * 64-bit Intel * 64-bit ARM (e.g. for Raspberry Pis and Macs) -There is no 32-bit version of Deno, and therefore we cannot offer a 32-bit version of SilverBullet either. +There is no 32-bit version of Deno, and therefore we cannot offer a 32-bit version of SilverBullet either. Most people run 64-bit OSes these days, an exception may be Raspberry Pis. Recent (RPI 3 and later) can run 64-bit Linux as well, you may have to re-image, though. -To use the docker container, first create a volume to keep your space (markdown) files: +A few key things to note on the SilverBullet container: +* The container binds to port `3000`, so be sure to export that, e.g. via `-p 3000:3000` +* The container uses whatever is volume-mapped to `/space` as the space root folder. You can connect a docker volume, or a host folder to this, e.g. `-v /home/myuser/space:/space` +* SilverBullet runs under Linux user id (uid) `1000` and group id (gid) `1000` inside the container. Conveniently, in most Linux distros this is the UID of the first non-root user you create. However, make sure that the space folder you mount into the container is _owned by uid 1000_. You can ensure this using: `chown -R 1000:1000 /path/to/space/folder`. + +To boot up the container: ```shell -docker volume create myspace -``` - -Then, run the container, e.g., as follows: - -```shell -docker run -p 3000:3000 -v myspace:/space -d zefhemel/silverbullet +docker run -p 3000:3000 -v /path/to/space/folder:/space -d zefhemel/silverbullet ``` The `zefhemel/silverbullet` image will give you the latest released version. This is equivalent to `zefhemel/silverbullet:latest`. If you prefer, you can also pin to a specific release, e.g. `zefhemel/silverbullet:0.5.5`. If you prefer to live on the bleeding edge, you can use the `zefhemel/silverbullet:edge` image, which is updated on every commit to the `main` brain. @@ -83,18 +85,52 @@ To configure various things such as authentication, use [[@env|environment varia docker run -p 3000:3000 -v myspace:/space -d -e SB_USER=me:letmein zefhemel/silverbullet ``` -To build your own version of the docker image, run `./scripts/build_docker.sh`. +## Upgrade +You can upgrade your image simply by pulling a new version of the image using `docker pull zefhemel/silverbullet`. However, it is recommended you use a tool like [watchtower](https://github.com/containrrr/watchtower) to automatically update your docker images and restart them. -To upgrade, simply pull the latest docker image and start a new container. +## Docker compose +Here is a simple `docker-compose.yml` that runs SilverBullet as well as [watchtower](https://github.com/containrrr/watchtower), which will check for new SilverBullet upgrades daily (the default) and upgrade automatically. -```shell -docker pull zefhemel/silverbullet +Instructions: +* Please replace the password defined in `SB_USER` with something sensible such as `admin:b3stp4ssword3vah` +* This volume uses the `notes` directory (that presumably exists) in the same directory as the `docker-compose.yml` file as the place where SB will keep its space. This folder is owned by UID 1000. + +```yaml +services: + silverbullet: + image: zefhemel/silverbullet:edge + restart: unless-stopped + environment: + - SB_USER="admin:admin" + volumes: + - ./notes:/space + ports: + - 3000:3000 + watchtower: + image: containrrr/watchtower + volumes: + - /var/run/docker.sock:/var/run/docker.sock ``` -## Configuration +Boot this up via: + +```shell +docker-compose up -d +``` + +And watch for logs with: + +```shell +docker-compose logs -f +``` + +## Building the docker image +To build your own version of the docker image, run `./scripts/build_docker.sh`. + +# Configuration SilverBullet is partially configured via flags (run it with `--help`) or alternatively via environment variables and partially via a [[SETTINGS]] page in your space. -## Environment variables +# Environment variables $env You can configure SB with environment variables instead of flags, which is probably what you want to do in a docker setup. The following environment variables are supported: