diff --git a/.github/workflows/main-docker.yml b/.github/workflows/main-docker.yml index 96bffbd6e..398cb4c58 100644 --- a/.github/workflows/main-docker.yml +++ b/.github/workflows/main-docker.yml @@ -1,148 +1,155 @@ on: - push: - branches: - - "develop" - - "feature/update**" - - "feature/server_esm**" - paths-ignore: - - "docs/**" - - "bin/**" - tags: - - "v*" - workflow_dispatch: + push: + branches: + - "develop" + - "feature/update**" + - "feature/server_esm**" + paths-ignore: + - "docs/**" + - "bin/**" + tags: + - "v*" + workflow_dispatch: env: - GHCR_REGISTRY: ghcr.io - DOCKERHUB_REGISTRY: docker.io - IMAGE_NAME: ${{ github.repository }} - TEST_TAG: triliumnext/notes:test - PLATFORMS: linux/amd64,linux/arm64,linux/arm/v7,linux/arm/v6 + GHCR_REGISTRY: ghcr.io + DOCKERHUB_REGISTRY: docker.io + IMAGE_NAME: ${{ github.repository }} + TEST_TAG: triliumnext/notes:test + PLATFORMS: linux/amd64,linux/arm64,linux/arm/v7,linux/arm64/v8 jobs: - test_docker: - name: Check Docker build - runs-on: ubuntu-latest - steps: - - name: Checkout the repository - uses: actions/checkout@v4 + test_docker: + name: Check Docker build + runs-on: ubuntu-latest + steps: + - name: Checkout the repository + uses: actions/checkout@v4 - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v3 + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 - - name: Set up node & dependencies - uses: actions/setup-node@v4 - with: - node-version: 20 - cache: "npm" - - - run: npm ci - - - name: Run the TypeScript build - run: npx tsc - - - name: Create server-package.json - run: cat package.json | grep -v electron > server-package.json - - - name: Build and export to Docker - uses: docker/build-push-action@v6 - with: - context: . - load: true - tags: ${{ env.TEST_TAG }} - cache-from: type=gha - cache-to: type=gha,mode=max - - - name: Run the container in the background - run: docker run -d --rm --name trilium_local ${{ env.TEST_TAG }} - - - name: Wait for the healthchecks to pass - uses: stringbean/docker-healthcheck-action@v1 - with: - container: trilium_local - wait-time: 50 - require-status: running - require-healthy: true - - build_docker: - name: Build Docker images - runs-on: ubuntu-latest - needs: - - test_docker - permissions: - contents: read - packages: write - attestations: write - id-token: write - steps: - - uses: actions/checkout@v4 - - name: Set up QEMU - uses: docker/setup-qemu-action@v3 - - name: Extract metadata (tags, labels) for GHCR image - id: ghcr-meta - uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7 - with: - images: ${{ env.GHCR_REGISTRY }}/${{ env.IMAGE_NAME }} - tags: - - name: Extract metadata (tags, labels) for DockerHub image - id: dh-meta - uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7 - with: - images: ${{ env.DOCKERHUB_REGISTRY }}/${{ env.IMAGE_NAME }} - name: Set up node & dependencies uses: actions/setup-node@v4 with: node-version: 20 cache: "npm" + - run: npm ci + - name: Run the TypeScript build run: npx tsc + - name: Create server-package.json run: cat package.json | grep -v electron > server-package.json - - name: Log in to the GHCR container registry - uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1 - with: - registry: ${{ env.GHCR_REGISTRY }} - username: ${{ github.actor }} - password: ${{ secrets.GITHUB_TOKEN }} - - uses: docker/setup-buildx-action@v3 - - name: Build and push container image to GHCR + + - name: Build and export to Docker uses: docker/build-push-action@v6 - id: ghcr-push with: context: . - platforms: ${{ env.PLATFORMS }} - push: true - tags: ${{ steps.ghcr-meta.outputs.tags }} - labels: ${{ steps.ghcr-meta.outputs.labels }} + load: true + tags: ${{ env.TEST_TAG }} cache-from: type=gha cache-to: type=gha,mode=max - - name: Generate and push artifact attestation to GHCR - uses: actions/attest-build-provenance@v1 + + - name: Run the container in the background + run: docker run -d --rm --name trilium_local ${{ env.TEST_TAG }} + + - name: Wait for the healthchecks to pass + uses: stringbean/docker-healthcheck-action@v1 with: - subject-name: ${{ env.GHCR_REGISTRY }}/${{ env.IMAGE_NAME}} - subject-digest: ${{ steps.ghcr-push.outputs.digest }} - push-to-registry: true - - name: Log in to the DockerHub container registry - uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1 - with: - registry: ${{ env.DOCKERHUB_REGISTRY }} - username: ${{ secrets.DOCKERHUB_USERNAME }} - password: ${{ secrets.DOCKERHUB_TOKEN }} - - name: Build and push image to DockerHub - uses: docker/build-push-action@v6 - id: dh-push - with: - context: . - platforms: ${{ env.PLATFORMS }} - push: true - tags: ${{ steps.dh-meta.outputs.tags }} - labels: ${{ steps.dh-meta.outputs.labels }} - cache-from: type=gha - cache-to: type=gha,mode=max - - name: Generate and push artifact attestation to DockerHub - uses: actions/attest-build-provenance@v1 - with: - subject-name: ${{ env.DOCKERHUB_REGISTRY }}/${{ env.IMAGE_NAME}} - subject-digest: ${{ steps.dh-push.outputs.digest }} - push-to-registry: true - \ No newline at end of file + container: trilium_local + wait-time: 50 + require-status: running + require-healthy: true + + build_docker: + name: Build Docker images + runs-on: ubuntu-latest + needs: + - test_docker + permissions: + contents: read + packages: write + attestations: write + id-token: write + strategy: + matrix: + architecture: [linux/amd64, linux/arm64, linux/arm/v7, linux/arm64/v8] + steps: + - uses: actions/checkout@v4 + - name: Extract metadata (tags, labels) for GHCR image + id: ghcr-meta + uses: docker/metadata-action@v4 + with: + images: ${{ env.GHCR_REGISTRY }}/${{ env.IMAGE_NAME }} + tags: | + type=ref,event=branch + type=ref,event=tag + type=sha + - name: Extract metadata (tags, labels) for DockerHub image + id: dh-meta + uses: docker/metadata-action@v4 + with: + images: ${{ env.DOCKERHUB_REGISTRY }}/${{ env.IMAGE_NAME }} + tags: | + type=ref,event=branch + type=ref,event=tag + type=sha + - name: Set up node & dependencies + uses: actions/setup-node@v4 + with: + node-version: 20 + cache: "npm" + - run: npm ci + - name: Run the TypeScript build + run: npx tsc + - name: Create server-package.json + run: cat package.json | grep -v electron > server-package.json + - name: Log in to the GHCR container registry + uses: docker/login-action@v2 + with: + registry: ${{ env.GHCR_REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + - uses: docker/setup-buildx-action@v3 + - name: Build and push container image to GHCR + uses: docker/build-push-action@v6 + id: ghcr-push + with: + context: . + platforms: ${{ matrix.architecture }} + push: true + tags: ${{ steps.ghcr-meta.outputs.tags }} + labels: ${{ steps.ghcr-meta.outputs.labels }} + cache-from: type=gha + cache-to: type=gha,mode=max + - name: Generate and push artifact attestation to GHCR + uses: actions/attest-build-provenance@v1 + with: + subject-name: ${{ env.GHCR_REGISTRY }}/${{ env.IMAGE_NAME}} + subject-digest: ${{ steps.ghcr-push.outputs.digest }} + push-to-registry: true + - name: Log in to the DockerHub container registry + uses: docker/login-action@v2 + with: + registry: ${{ env.DOCKERHUB_REGISTRY }} + username: ${{ secrets.DOCKERHUB_USERNAME }} + password: ${{ secrets.DOCKERHUB_TOKEN }} + - name: Build and push image to DockerHub + uses: docker/build-push-action@v6 + id: dh-push + with: + context: . + platforms: ${{ matrix.architecture }} + push: true + tags: ${{ steps.dh-meta.outputs.tags }} + labels: ${{ steps.dh-meta.outputs.labels }} + cache-from: type=gha + cache-to: type=gha,mode=max + - name: Generate and push artifact attestation to DockerHub + uses: actions/attest-build-provenance@v1 + with: + subject-name: ${{ env.DOCKERHUB_REGISTRY }}/${{ env.IMAGE_NAME}} + subject-digest: ${{ steps.dh-push.outputs.digest }} + push-to-registry: true \ No newline at end of file diff --git a/.gitignore b/.gitignore index 91e8f08c3..7d012a354 100644 --- a/.gitignore +++ b/.gitignore @@ -18,8 +18,6 @@ tmp/ out/ -images/app-icons/png/16x16.png -images/app-icons/png/32x32.png images/app-icons/png/512x512.png images/app-icons/png/1024x1024.png images/app-icons/mac/*.png @@ -27,3 +25,4 @@ images/app-icons/mac/*.png /playwright-report/ /blob-report/ /playwright/.cache/ +/playwright/.auth/ \ No newline at end of file diff --git a/Dockerfile b/Dockerfile index 339f44fd3..2dc3ccef4 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,8 +1,8 @@ # !!! Don't try to build this Dockerfile directly, run it through bin/build-docker.sh script !!! -FROM node:20.15.1-alpine +FROM node:20.15.1-bullseye-slim # Configure system dependencies -RUN apk add --no-cache --virtual .build-dependencies \ +RUN apt-get update && apt-get install -y --no-install-recommends \ autoconf \ automake \ g++ \ @@ -11,7 +11,9 @@ RUN apk add --no-cache --virtual .build-dependencies \ make \ nasm \ libpng-dev \ - python3 + python3 \ + gosu \ + && rm -rf /var/lib/apt/lists/* # Create app directory WORKDIR /usr/src/app @@ -32,24 +34,33 @@ RUN rm docker_healthcheck.ts RUN rm -r build # Install app dependencies -RUN set -x \ - && npm install \ - && apk del .build-dependencies \ - && npm run webpack \ - && npm prune --omit=dev \ - && cp src/public/app/share.js src/public/app-dist/. \ - && cp -r src/public/app/doc_notes src/public/app-dist/. \ - && rm -rf src/public/app \ - && rm src/services/asset_path.ts +RUN set -x +RUN npm install +RUN apt-get purge -y --auto-remove \ + autoconf \ + automake \ + g++ \ + gcc \ + libtool \ + make \ + nasm \ + libpng-dev \ + python3 \ + && rm -rf /var/lib/apt/lists/* +RUN npm run webpack +RUN npm prune --omit=dev +RUN cp src/public/app/share.js src/public/app-dist/. +RUN cp -r src/public/app/doc_notes src/public/app-dist/. +RUN rm -rf src/public/app +RUN rm src/services/asset_path.ts # Some setup tools need to be kept -RUN apk add --no-cache su-exec shadow - -# Add application user and setup proper volume permissions -RUN adduser -s /bin/false node; exit 0 +RUN apt-get update && apt-get install -y --no-install-recommends \ + gosu \ + && rm -rf /var/lib/apt/lists/* # Start the application EXPOSE 8080 CMD [ "./start-docker.sh" ] -HEALTHCHECK --start-period=10s CMD exec su-exec node node docker_healthcheck.js +HEALTHCHECK --start-period=10s CMD exec gosu node node docker_healthcheck.js \ No newline at end of file diff --git a/bin/build-docker.sh b/bin/build-docker.sh index 9d614eb2b..a765930db 100755 --- a/bin/build-docker.sh +++ b/bin/build-docker.sh @@ -10,8 +10,8 @@ cat package.json | grep -v electron > server-package.json echo "Compiling typescript..." npx tsc -sudo docker build -t zadam/trilium:$VERSION --network host -t zadam/trilium:$SERIES . +sudo docker build -t triliumnext/notes:$VERSION --network host -t triliumnext/notes:$SERIES . if [[ $VERSION != *"beta"* ]]; then - sudo docker tag zadam/trilium:$VERSION zadam/trilium:latest + sudo docker tag triliumnext/notes:$VERSION triliumnext/notes:latest fi diff --git a/docker-compose.yml b/docker-compose.yml index 6798574ac..d6f5a3c65 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,16 +1,21 @@ # Running `docker-compose up` will create/use the "trilium-data" directory in the user home # Run `TRILIUM_DATA_DIR=/path/of/your/choice docker-compose up` to set a different directory -version: '2.1' +# To run in the background, use `docker-compose up -d` services: trilium: - image: zadam/trilium - restart: always + # Optionally, replace `latest` with a version tag like `v0.90.3` + # Using `latest` may cause unintended updates to the container + image: triliumnext/notes:latest + # Restart the container unless it was stopped by the user + restart: unless-stopped environment: - TRILIUM_DATA_DIR=/home/node/trilium-data ports: - - "8080:8080" + # By default, Trilium will be available at http://localhost:8080 + # It will also be accessible at http://:8080 + # You might want to limit this with something like Docker Networks, reverse proxies, or firewall rules, such as UFW + - '8080:8080' volumes: + # Unless TRILIUM_DATA_DIR is set, the data will be stored in the "trilium-data" directory in the home directory. + # This can also be changed with by replacing the line below with `- /path/of/your/choice:/home/node/trilium-data - ${TRILIUM_DATA_DIR:-~/trilium-data}:/home/node/trilium-data - -volumes: - trilium: diff --git a/images/app-icons/png/16x16.png b/images/app-icons/png/16x16.png new file mode 100644 index 000000000..4645fe056 Binary files /dev/null and b/images/app-icons/png/16x16.png differ diff --git a/images/app-icons/png/32x32.png b/images/app-icons/png/32x32.png new file mode 100644 index 000000000..dbe57df0e Binary files /dev/null and b/images/app-icons/png/32x32.png differ diff --git a/integration-tests/auth.setup.ts b/integration-tests/auth.setup.ts new file mode 100644 index 000000000..ba2670006 --- /dev/null +++ b/integration-tests/auth.setup.ts @@ -0,0 +1,17 @@ +import { test as setup, expect } from '@playwright/test'; + +const authFile = 'playwright/.auth/user.json'; + +const ROOT_URL = "http://localhost:8080"; +const LOGIN_PASSWORD = "eliandoran"; + +// Reference: https://playwright.dev/docs/auth#basic-shared-account-in-all-tests + +setup("authenticate", async ({ page }) => { + await page.goto(ROOT_URL); + await expect(page).toHaveURL(`${ROOT_URL}/login`); + + await page.getByRole("textbox", { name: "Password" }).fill(LOGIN_PASSWORD); + await page.getByRole("button", { name: "Login"}).click(); + await page.context().storageState({ path: authFile }); +}); \ No newline at end of file diff --git a/integration-tests/example.spec.ts b/integration-tests/example.disabled.ts similarity index 100% rename from integration-tests/example.spec.ts rename to integration-tests/example.disabled.ts diff --git a/integration-tests/katex.spec.ts b/integration-tests/katex.disabled.ts similarity index 67% rename from integration-tests/katex.spec.ts rename to integration-tests/katex.disabled.ts index 1b6be60a5..c1ce0d9d7 100644 --- a/integration-tests/katex.spec.ts +++ b/integration-tests/katex.disabled.ts @@ -7,14 +7,6 @@ test("Can insert equations", async ({ page }) => { await page.setDefaultTimeout(60_000); await page.setDefaultNavigationTimeout(60_000); - await page.goto(ROOT_URL); - await expect(page).toHaveURL(`${ROOT_URL}/login`); - - // Log in - await page.getByRole("textbox", { name: "Password" }).fill(LOGIN_PASSWORD); - await page.getByRole("button", { name: "Login"}).click(); - await page.waitForURL(/\/#root\//); - // Create a new note // await page.locator("button.button-widget.bx-file-blank") // .click(); diff --git a/integration-tests/update_check.spec.ts b/integration-tests/update_check.spec.ts new file mode 100644 index 000000000..207395296 --- /dev/null +++ b/integration-tests/update_check.spec.ts @@ -0,0 +1,12 @@ +import { test, expect } from '@playwright/test'; + +const expectedVersion = "0.90.3"; + +test("Displays update badge when there is a version available", async ({ page }) => { + await page.goto("http://localhost:8080"); + await page.getByRole('button', { name: '' }).click(); + await page.getByText(`Version ${expectedVersion} is available,`).click(); + + const page1 = await page.waitForEvent('popup'); + expect(page1.url()).toBe(`https://github.com/TriliumNext/Notes/releases/tag/v${expectedVersion}`); +}); \ No newline at end of file diff --git a/playwright.config.ts b/playwright.config.ts index 10528c325..12420d3a5 100644 --- a/playwright.config.ts +++ b/playwright.config.ts @@ -34,13 +34,17 @@ export default defineConfig({ /* Configure projects for major browsers */ projects: [ { - name: 'chromium', - use: { ...devices['Desktop Chrome'] }, + name: "setup", + testMatch: /.*\.setup\.ts/ }, { - name: 'firefox', - use: { ...devices['Desktop Firefox'] }, + name: "firefox", + use: { + ...devices[ "Desktop Firefox" ], + storageState: "playwright/.auth/user.json" + }, + dependencies: [ "setup" ] }, /* Test against mobile viewports. */ diff --git a/src/public/app/widgets/buttons/global_menu.js b/src/public/app/widgets/buttons/global_menu.js index b934b4118..e4aed7ba7 100644 --- a/src/public/app/widgets/buttons/global_menu.js +++ b/src/public/app/widgets/buttons/global_menu.js @@ -338,7 +338,7 @@ export default class GlobalMenuWidget extends BasicWidget { } downloadLatestVersionCommand() { - window.open("https://github.com/zadam/trilium/releases/latest"); + window.open("https://github.com/TriliumNext/Notes/releases/latest"); } activeContextChangedEvent() { diff --git a/src/public/stylesheets/ckeditor-theme.css b/src/public/stylesheets/ckeditor-theme.css index eac57cf47..225788c5b 100644 --- a/src/public/stylesheets/ckeditor-theme.css +++ b/src/public/stylesheets/ckeditor-theme.css @@ -4,6 +4,7 @@ body { --ck-color-base-text: var(--main-text-color); --ck-color-base-foreground: var(--accented-background-color); --ck-color-base-background: var(--main-background-color); + --ck-color-dialog-background: var(--ck-color-base-background); --ck-color-focus-border: var(--main-border-color); --ck-color-text: var(--main-text-color); --ck-color-shadow-drop: var(--main-background-color); diff --git a/start-docker.sh b/start-docker.sh index 823b6eba9..ffdcb4148 100755 --- a/start-docker.sh +++ b/start-docker.sh @@ -4,4 +4,4 @@ [[ ! -z "${USER_GID}" ]] && groupmod -og ${USER_GID} node || echo "No USER_GID specified, leaving 1000" chown -R node:node /home/node -exec su-exec node node ./src/www +exec su -c "node ./src/www" node