diff --git a/README.md b/README.md index 665128297b9365ec97b049b597c6d1c04c463a64..6f2fcac0bed0f84c4df44a133d67b50ebd555cae 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,21 @@ [GitLab Repository](https://gitlab.tugraz.at/dbp/cli) | [npmjs package](https://www.npmjs.com/package/@digital-blueprint/cli) -This is CLI to manage DBP frontend applications and Symfony bundles. +This is CLI to manage DBP frontend applications. ## Install apps +`npx @digital-blueprint/cli install-app <package-name> <destination-directory> <server-path-prefix>` + +* `package-name` - the application that you want to install. See https://www.npmjs.com/search?q=%40dbp-topics for a list of applications. +* `destination-directory` - the local directory where the application should be installed to +* `server-path-prefix` - the URL path under which the application will be reachable on the web server. e.g. `/` in case it is `myapp.mydomain.org`, or `/myapp` in case it is `mydomain.org/myapp`. + If you want to install the DBP Signature App in a new folder `signature-app` with a path prefix `/` you can call: ```bash -npx @digital-blueprint/cli install-app signature signature-app / + +npx @digital-blueprint/cli install-app @dbp-topics/signature signature-app / ``` Afterwards you can point your Apache web-server to `signature-app/public`. @@ -32,10 +39,12 @@ To do this you can for example open a shell with `runuser -u www-data -- bash`. ## Update apps +`npx @digital-blueprint/cli update-ap <package-name>` + If you want to update the DBP Signature App in the current folder you can call: ```bash -npx @digital-blueprint/cli update-app signature +npx @digital-blueprint/cli update-app @dbp-topics/signature ``` **Warning:** There may be issues when you run these commands as root user, best use a non-root user, like `www-data`.