diff --git a/README.md b/README.md index a7b5409..a911034 100644 --- a/README.md +++ b/README.md @@ -52,3 +52,21 @@ The Asset Management module in an ERP system typically encompasses several key a ### 10. User Access and Security - control and manage access to asset management functionalities. - **Role-Based Access Control:** Defining user roles and permissions related to asset management tasks. - **Security Measures:** Ensuring data protection and security of asset information. + +## Local Development with Docker + +When running this project inside the codbex Atlas Docker image, you must provide authentication for installing dependencies from GitHub Packages. +1. Create a GitHub Personal Access Token (PAT) with `read:packages` scope. +2. Pass `NPM_TOKEN` to the Docker container: + + ``` + docker run \ + -e NPM_TOKEN= \ + --rm -p 80:80 \ + ghcr.io/codbex/codbex-atlas:latest + ``` + +⚠️ **Notes** +- The `NPM_TOKEN` must be available at container runtime. +- This is required even for public packages hosted on GitHub Packages. +- Never bake the token into the Docker image or commit it to source control. diff --git a/codbex-assets/.npmrc b/codbex-assets/.npmrc index a822756..3bdca56 100644 --- a/codbex-assets/.npmrc +++ b/codbex-assets/.npmrc @@ -1,3 +1,2 @@ -registry=https://registry.npmjs.org/ - @codbex:registry=https://npm.pkg.github.com +//npm.pkg.github.com/:_authToken=${NPM_TOKEN}