diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml index a7501608..d0ec3525 100644 --- a/.github/workflows/docker.yml +++ b/.github/workflows/docker.yml @@ -56,9 +56,6 @@ jobs: registry: ghcr.io username: ${{ github.actor }} password: ${{ secrets.GITHUB_TOKEN }} - # - # MetaData Extract Docu: - # - name: Extract metadata (tags, labels) for Docker id: meta uses: docker/metadata-action@v4.4.0 diff --git a/.github/workflows/server.yml b/.github/workflows/server.yml index 56fe536a..0cce0c69 100644 --- a/.github/workflows/server.yml +++ b/.github/workflows/server.yml @@ -24,7 +24,6 @@ jobs: - name: Build bundles run: | deno task build - deno task bundle - name: Compile for all platforms run: | diff --git a/website/2.md b/website/2.md index 3d9c53f3..c665a8e8 100644 --- a/website/2.md +++ b/website/2.md @@ -27,6 +27,8 @@ Features previously built as [[Plugs]] (in TypeScript) are now slowly being rebu What was previously known as “sync mode” is now the default and only mode in SilverBullet v2. This means that **all your content is continuously kept in sync** between your clients via your server, and all processing happens locally. No internet connection? No problem, you will have access to all your notes, can edit them and everything works the same as when online. +Overall, tons of minor fixes, refinements and tweaks were made. It’s good stuff. + ## Installing See the [[Install|installation options]]. diff --git a/website/Install/Binary.md b/website/Install/Binary.md index ba21a9ce..1d06c908 100644 --- a/website/Install/Binary.md +++ b/website/Install/Binary.md @@ -4,11 +4,8 @@ SilverBullet is distributed as a single server binary available for the followin * Linux (x86_64 and arm64) (note that this will run on Raspberry Pi as well, but requires a 64-bit Linux distribution) * Windows (64-bit) -> **note** Note -> Since v2 is still in beta, please use the [edge](https://github.com/silverbulletmd/silverbullet/releases/tag/edge) builds for now, all previous releases are still “v1” - Steps: -1. [Download the binary for your platform from Github](https://github.com/silverbulletmd/silverbullet/releases/tag/edge). +1. [Download the binary for your platform from Github](https://github.com/silverbulletmd/silverbullet/releases). 2. Unzip the file in a convenient place 3. Run it from the command line (see below) @@ -27,13 +24,21 @@ SilverBullet binaries are not signed, therefore when you run `silverbullet` on m To work around this, go into your Mac’s System Settings. In the Privacy & Security section, make sure you allow applications from App Store & Known Developers. If you’ve run silverbullet from the CLI already and failed, you’ll see it listed here with an option to override. Select that option and run it again from the CLI, you should now have an addition “Run anyway” button. Click it, authenticate and from this point all should be good. # Upgrading -You can upgrade your SilverBullet install to the latest edge build using: +You can upgrade your SilverBullet install based on the version you’d like to run. + +To upgrade to the latest **stable** release: + +```bash +./silverbullet upgrade +``` + +To upgrade to the latest **edge** release (which keeps in sync with the `main` development branch): ```bash ./silverbullet upgrade-edge ``` -Release versions will come when the first proper v2 release happens. +To upgrade your client, be sure to refresh your page _twice_ somewhat slowly. # Version -To check which version of SilverBullet you’re running, run the ${widgets.commandButton("Help: Version")} command. +To check which version of SilverBullet you’re running, run the ${widgets.commandButton("Client: Version")} command. diff --git a/website/Install/Docker.md b/website/Install/Docker.md index dc94250a..d893c3bc 100644 --- a/website/Install/Docker.md +++ b/website/Install/Docker.md @@ -24,7 +24,7 @@ For your first run, you can run the following: # Create a local folder "space" to keep files in mkdir -p space # Run the SilverBullet docker container in the foreground -sudo docker run -it -p 3000:3000 -v ./space:/space ghcr.io/silverbulletmd/silverbullet:v2 +sudo docker run -it -p 3000:3000 -v ./space:/space ghcr.io/silverbulletmd/silverbullet ``` This will run SilverBullet in the foreground, interactively, so you can see the logs and instructions. @@ -34,7 +34,7 @@ If this all works fine, just kill the thing with `Ctrl-c` (don’t worry, it’s Now you probably want to run the container in daemon (background) mode, give it a name, and automatically have it restart after you e.g. reboot your machine: ```shell -docker run -d --restart unless-stopped --name silverbullet -p 3000:3000 -v ./space:/space ghcr.io/silverbulletmd/silverbullet:v2 +docker run -d --restart unless-stopped --name silverbullet -p 3000:3000 -v ./space:/space ghcr.io/silverbulletmd/silverbullet ``` There you go! @@ -50,24 +50,30 @@ In this page, put `apt` commands install the (ubuntu) packages you would like to This page will be run as a bash script upon container boot (hence its name). You can monitor its progress by checking your server’s logs. # Versions -As we’re working on SilverBullet v2, your only real option is to use the “edge” versions with the `:v2` tag. +There are two release channels: +* Stable: for this use the `:latest` images +* Edge: for this use the `:v2` tag (e.g. `ghcr.io/silverbulletmd/silverbullet:v2`) — these images are always in sync with the `main` development branch. -## Upgrade +To check the version you’re running, use the ${widgets.commandButton("Client: Version")} command. + +# Upgrade You can upgrade SilverBullet as follows: ```shell # Pull the latest version of the image -docker pull ghcr.io/silverbulletmd/silverbullet:v2 +docker pull ghcr.io/silverbulletmd/silverbullet # Kill the running container docker kill silverbullet # Remove the old container docker rm silverbullet # Start a fresh one (same command as before) -docker run -d --restart unless-stopped --name silverbullet -p 3000:3000 -v $PWD/space:/space ghcr.io/silverbulletmd/silverbullet:v2 +docker run -d --restart unless-stopped --name silverbullet -p 3000:3000 -v $PWD/space:/space ghcr.io/silverbulletmd/silverbullet ``` Since this is somewhat burdensome, it is recommended you use a tool like [watchtower](https://github.com/containrrr/watchtower) to automatically update your docker images and restart them. However, if we go there — we may as well use a tool like _docker compose_ to manage your containers, no? +To upgrade your client, be sure to refresh your page _twice_ somewhat slowly. + # Docker compose [Docker compose](https://docs.docker.com/compose/) is a simple tool to manage running of multiple containers on a server you control. It’s like Kubernetes, but you know, not insanely complex. @@ -81,7 +87,7 @@ Instructions: ```yaml services: silverbullet: - image: ghcr.io/silverbulletmd/silverbullet:v2 + image: ghcr.io/silverbulletmd/silverbullet restart: unless-stopped environment: - SB_USER=admin:admin