diff --git a/.changeset/spicy-places-pick.md b/.changeset/spicy-places-pick.md new file mode 100644 index 0000000000..49f251f634 --- /dev/null +++ b/.changeset/spicy-places-pick.md @@ -0,0 +1,5 @@ +--- +'@wbce-d9/directus9': patch +--- + +Update docker url diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 58fb8777c7..723a3751c2 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -7,7 +7,8 @@ on: env: GHCR_IMAGE: ghcr.io/${{ github.repository }} - DOCKERHUB_IMAGE: ${{ github.repository }} + DOCKERHUB_IMAGE: lawebcapsule/d9 + DOCKERHUB_IMAGE_OLD: lawebcapsule/directus9 jobs: create-release: @@ -66,6 +67,7 @@ jobs: with: images: | ${{ env.DOCKERHUB_IMAGE }} + ${{ env.DOCKERHUB_IMAGE_OLD }} ${{ env.GHCR_IMAGE }} tags: | type=semver,pattern={{version}} diff --git a/Dockerfile b/Dockerfile index d6e770fe94..3c68e90eae 100644 --- a/Dockerfile +++ b/Dockerfile @@ -14,6 +14,7 @@ RUN corepack enable && corepack prepare COPY pnpm-lock.yaml . RUN pnpm fetch COPY . . +ENV CI=true RUN pnpm install --recursive --offline --frozen-lockfile RUN : \ diff --git a/directus/package.json b/directus/package.json index b4269b80c7..2342cf98c0 100644 --- a/directus/package.json +++ b/directus/package.json @@ -53,7 +53,8 @@ "./package.json": "./package.json" }, "bin": { - "directus": "cli.js" + "directus": "cli.js", + "d9": "cli.js" }, "dependencies": { "@wbce-d9/api": "workspace:*" diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js index d0e5a366cf..b18beac65b 100644 --- a/docs/.vitepress/config.js +++ b/docs/.vitepress/config.js @@ -44,11 +44,12 @@ export default defineConfig({ title: 'd9 Docs', description: 'd9 — Open Data Platform. An Instant App & API for your SQL Database.', ignoreDeadLinks: true, + appearance: "dark", vite: { plugins: [markdownVariablesPlugin()], }, markdown: { - theme: 'material-theme-palenight', + theme: { light: 'github-light', dark: 'material-theme-palenight' }, toc: { level: [2], }, diff --git a/docs/.vitepress/constants.js b/docs/.vitepress/constants.js index c9188290f3..d8602bae98 100644 --- a/docs/.vitepress/constants.js +++ b/docs/.vitepress/constants.js @@ -6,7 +6,7 @@ export const URLS = { GITHUB_COMMUNITY: 'https://github.com/LaWebcapsule/directus9/discussions', LOCALES: 'https://locales.directus.io', NPM: 'https://www.npmjs.com/package/@wbce-d9/directus9', - DOCKER_HUB: 'https://github.com/LaWebcapsule/directus9/pkgs/container/directus9', + DOCKER_HUB: 'https://hub.docker.com/r/lawebcapsule/d9', }; export const EMAILS = { diff --git a/docs/contributing/codebase-overview.md b/docs/contributing/codebase-overview.md index 0b3e9d6db9..447b35df6a 100644 --- a/docs/contributing/codebase-overview.md +++ b/docs/contributing/codebase-overview.md @@ -14,7 +14,7 @@ readTime: 3 min read ## Monorepo -The primary d9 repository is located at [`directus/directus`]({{GITHUB_URL}}) and +The primary d9 repository is located at [`lawebcapsule/d9`]({{GITHUB_URL}}) and houses the Admin App (Vue.js 3 w/ Composition API), API (Node.js), API Specification (OpenAPI), and other smaller packages used internally. d9 follows a monorepo design similar to React or Babel — this page will outline our monorepo's design and structure. diff --git a/docs/getting-started/quickstart.md b/docs/getting-started/quickstart.md index a396e6d5e3..2ce54410e7 100644 --- a/docs/getting-started/quickstart.md +++ b/docs/getting-started/quickstart.md @@ -13,7 +13,7 @@ readTime: 7 min read ## 1. Install & Start d9 -The fastest way to get started is with Docker: +### With Docker (fastest way) ```bash docker run -d \ @@ -24,13 +24,36 @@ docker run -d \ -e ADMIN_PASSWORD=your-password \ -e DB_CLIENT=sqlite3 \ -e DB_FILENAME=/directus/database/data.db \ - ghcr.io/lawebcapsule/directus9:latest + lawebcapsule/d9:latest ``` -Or with npm: +Once running, open `http://localhost:8055` in your browser and log in with the admin credentials you set above. + +### With npm + +Install d9 as an npm package: + +```bash +npm init +npm install @wbce-d9/directus9 +``` + +Create a `.env` file at the root of your directory with the following content: + +``` +KEY=some-random-key +SECRET=another-random-key +DB_CLIENT=sqlite3 +DB_FILENAME=./data.db +ADMIN_EMAIL=admin@example.com +ADMIN_PASSWORD=your-password +``` + +Then bootstrap and start the server: ```bash -npm init @wbce-d9/directus-project@latest +npx directus bootstrap +npx directus start ``` Once running, open `http://localhost:8055` in your browser and log in with the admin credentials you set above. diff --git a/docs/self-hosted/docker-guide.md b/docs/self-hosted/docker-guide.md index 12d0810033..b18d05fe33 100644 --- a/docs/self-hosted/docker-guide.md +++ b/docs/self-hosted/docker-guide.md @@ -13,7 +13,7 @@ problems. If you can't or don't want to use Docker, we also publish an ::: -d9 is published to [Docker Hub]({{DOCKER_HUB_URL}}) under `directus/directus`. To use the +d9 is published to [Docker Hub]({{DOCKER_HUB_URL}}) under `lawebcapsule/d9`. To use the latest d9 image from Docker Hub, run: ```bash @@ -22,16 +22,16 @@ docker run \ -p 8055:8055 \ -e KEY=255d861b-5ea1-5996-9aa3-922530ec40b1 \ -e SECRET=6116487b-cda1-52c2-b5b5-c8022c45e263 \ - directus/directus + lawebcapsule/d9 ``` ### Installing Specific Versions To stick to a more specific version of d9 you can use one of the following tags: -- Full version, e.g. `9.0.0` -- Minor releases, e.g. `9.0` -- Major releases, e.g. `9` +- Full version, e.g. `12.0.1` +- Minor releases, e.g. `12.0` +- Major releases, e.g. `12` To use a specific version of d9, run: @@ -41,7 +41,7 @@ docker run \ -p 8055:8055 \ -e KEY=255d861b-5ea1-5996-9aa3-922530ec40b1 \ -e SECRET=6116487b-cda1-52c2-b5b5-c8022c45e263 \ - directus/directus:9.0.0 + lawebcapsule/d9:12.0.1 ``` ### Configure Admin User @@ -97,7 +97,7 @@ services: directus: container_name: directus - image: directus/directus:latest + image: lawebcapsule/d9:latest ports: - 8055:8055 volumes: @@ -146,8 +146,8 @@ If you are not using the `latest` tag for the d9 image you need to adjust your ` increment the tag version number, e.g.: ```diff -- image: directus/directus:9.0.0-rc.101 -+ image: directus/directus:9.0.0 +- image: lawebcapsule/d9:9.0.0-rc.101 ++ image: lawebcapsule/d9:9.0.0 ``` You can then issue the following two commands (from your docker-compose root): diff --git a/docs/self-hosted/quickstart.md b/docs/self-hosted/quickstart.md index 19aac5b493..bdae0996bd 100644 --- a/docs/self-hosted/quickstart.md +++ b/docs/self-hosted/quickstart.md @@ -24,7 +24,7 @@ like `KEY`, `SECRET`, `ADMIN_PASSWORD`, _etc._ version: '3' services: directus: - image: directus/directus:latest + image: lawebcapsule/d9:latest ports: - 8055:8055 volumes: