Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ SLIDES_PASSWORD=change-me-to-something-long
# Your user and group, so files written to ./out belong to you: run `id -u` and `id -g`.
SLIDES_UID=1000
SLIDES_GID=1000
# What to install in the image: an npm name such as @slide-ng/core@3.5.1, or a tarball in ./packages.
SLIDE_NG_SOURCE=@slide-ng/core@3.5.1
# What to install in the image: an npm name such as @slide-ng/core@3.6.0, or a tarball in ./packages.
SLIDE_NG_SOURCE=@slide-ng/core@3.6.0
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ body:
id: image
attributes:
label: Image tag or commit, and slide.ng version
placeholder: slide-ng-docker:local built from commit abc1234, slide.ng 3.5.1
placeholder: slide-ng-docker:local built from commit abc1234, slide.ng 3.6.0
validations:
required: true
- type: input
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ on:
workflow_dispatch:
inputs:
slide_ng_source:
description: "SLIDE_NG_SOURCE: an npm name such as @slide-ng/core@3.5.1. Leave empty to pack the slide.ng repository."
description: "SLIDE_NG_SOURCE: an npm name such as @slide-ng/core@3.6.0. Leave empty to pack the slide.ng repository."
required: false

permissions:
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ All notable changes are listed here. The format follows [Keep a Changelog](https
- The repository is now `slide-ng/docker` (it was `slide-ng/slide.ng-docker`); links point to the new name.
- The image installs `@slide-ng/core@2.0.0` from npm by default (it was `0.1.0`; the first default, `slide-ng`, was not the package name). `.env.example` and `docker-compose.yml` use the same default; a tarball in `packages/` still works.
- The image installs `@slide-ng/core@2.2.0` by default (it was `2.0.0`). A deck's `slide-ng.config.yaml`, new in slide.ng 2.2, sits next to `slides.md` in `/slides`, so every mode reads it and `watch` rebuilds when it changes.
- The image installs `@slide-ng/core@3.5.1` by default (it was `3.4.0`, before that `3.3.0`, `3.2.0`, `3.1.1`, `3.1.0`, `3.0.0` and `2.2.0`). slide.ng 3.1's `browser.proxy` needs no change to the image: the proxy is a separate host that a deck names in its headmatter.
- The image installs `@slide-ng/core@3.6.0` by default (it was `3.5.1`, before that `3.4.0`, `3.3.0`, `3.2.0`, `3.1.1`, `3.1.0`, `3.0.0` and `2.2.0`). slide.ng 3.1's `browser.proxy` needs no change to the image: the proxy is a separate host that a deck names in its headmatter.
- `serve.mjs` lets browsers keep the `inline-*.js` files of a slide.ng 2.0 build (the scripts moved out of `index.html`), as it does for the other files with a hash in their name.
- The README says how `--router-mode` and a Content-Security-Policy work with the image.
- The README says how slide.ng 3.0's deck browser works with the image: `dev` runs with `--remote`, so its local proxy is off and pages load directly, with no extra port; a Content-Security-Policy in front of a build needs `frame-src` for the sites it shows.
Expand Down
4 changes: 2 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ RUN apt-get update \

# --- 2. slide.ng itself. A global install keeps its dependencies inside the package folder, which is
# where slide.ng looks for them. SLIDE_NG_SOURCE is one of:
# - a file inside this build context, such as packages/slide-ng-core-3.5.1.tgz (made with `npm pack`)
# - a file inside this build context, such as packages/slide-ng-core-3.6.0.tgz (made with `npm pack`)
# - anything npm understands: a package name or name@version
# The default is a pinned @slide-ng/core release from npm; bump it when a new one is published.
ARG SLIDE_NG_SOURCE=@slide-ng/core@3.5.1
ARG SLIDE_NG_SOURCE=@slide-ng/core@3.6.0
COPY packages/ /tmp/context/packages/
# slide.ng never downloads a browser (it uses CHROME_PATH), this only makes that certain for its dependencies.
ENV PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ The commands marked NOT VERIFIED above are untested. An earlier check on Docker

## Build the image

By default the image installs `@slide-ng/core@3.5.1` from npm (a pinned release, so builds are reproducible). The build
By default the image installs `@slide-ng/core@3.6.0` from npm (a pinned release, so builds are reproducible). The build
argument `SLIDE_NG_SOURCE` picks another version (anything `npm install` accepts, such as `@slide-ng/core@latest`) or a
tarball inside the build context, for example one packed from a slide.ng checkout:

```sh
docker build -t slide-ng .
docker build --build-arg SLIDE_NG_SOURCE=@slide-ng/core@latest -t slide-ng .
npm pack /path/to/slide.ng --pack-destination packages
docker build --build-arg SLIDE_NG_SOURCE=packages/slide-ng-core-3.5.1.tgz -t slide-ng .
docker build --build-arg SLIDE_NG_SOURCE=packages/slide-ng-core-3.6.0.tgz -t slide-ng .
```

Other build arguments: `NODE_VERSION` (default `22.23.3`; slide.ng needs 22.22.3 or newer) and `EXTRA_FONTS`
Expand Down
4 changes: 2 additions & 2 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ x-common: &common
build:
context: .
args:
# An npm name such as @slide-ng/core@3.5.1, or a tarball made with `npm pack` (see README).
SLIDE_NG_SOURCE: ${SLIDE_NG_SOURCE:-@slide-ng/core@3.5.1}
# An npm name such as @slide-ng/core@3.6.0, or a tarball made with `npm pack` (see README).
SLIDE_NG_SOURCE: ${SLIDE_NG_SOURCE:-@slide-ng/core@3.6.0}
# Files in ./out are yours, not uid 1000's. Set SLIDES_UID and SLIDES_GID in .env (`id -u`, `id -g`).
user: "${SLIDES_UID:-1000}:${SLIDES_GID:-1000}"
cap_drop: [ALL]
Expand Down
Loading