Skip to content
Snippets Groups Projects
Commit 2315f59f authored by Reiter, Christoph's avatar Reiter, Christoph :snake:
Browse files

README: expand the documentation of the command parameters a bit

And switch to full package names so we can point to npmjs
parent 8b4c6c8f
Branches
No related tags found
No related merge requests found
Pipeline #187075 passed
...@@ -3,14 +3,21 @@ ...@@ -3,14 +3,21 @@
[GitLab Repository](https://gitlab.tugraz.at/dbp/cli) | [GitLab Repository](https://gitlab.tugraz.at/dbp/cli) |
[npmjs package](https://www.npmjs.com/package/@digital-blueprint/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 ## 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: If you want to install the DBP Signature App in a new folder `signature-app` with a path prefix `/` you can call:
```bash ```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`. 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`. ...@@ -32,10 +39,12 @@ To do this you can for example open a shell with `runuser -u www-data -- bash`.
## Update apps ## 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: If you want to update the DBP Signature App in the current folder you can call:
```bash ```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`. **Warning:** There may be issues when you run these commands as root user, best use a non-root user, like `www-data`.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment