Skip to content

Commit a135d19

Browse files
authored
Merge branch 'master' into stage
2 parents 83da9fc + 336b9b1 commit a135d19

File tree

3 files changed

+41
-9
lines changed

3 files changed

+41
-9
lines changed

.github/workflows/trigger-deploy.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ jobs:
1515
trigger-zpm-deployment:
1616
name: Trigger zpm-registry-deployment via REST API
1717
runs-on: ubuntu-22.04
18-
1918
steps:
2019
- name: REST POST call
2120
run: |-

README.md

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# intersystems zpm-registry
2-
[![Quality Gate Status](https://community.objectscriptquality.com/api/project_badges/measure?project=intersystems_iris_community%2Fzpm-registry&metric=alert_status)](https://community.objectscriptquality.com/dashboard?id=intersystems_iris_community%2Fzpm-registry)
2+
[![Quality Gate Status](https://community.objectscriptquality.com/api/project_badges/measure?project=intersystems_iris_community%2Fzpm-registry&metric=alert_status)](https://community.objectscriptquality.com/dashboard?id=intersystems_iris_community%2Fzpm-registry)
33

44
ZPM Registry is a a server part of ObjectScript Package Manager.
55

@@ -13,26 +13,59 @@ You can use ZPM Registry project to build your own private registry to have the
1313
ZPM Registry works only on IRIS and IRIS For Health, community and Enterprise versions.
1414

1515
# Installation
16-
## Usual Installation
17-
Import classes from cls and run Installer from Root
16+
17+
## ZPM Installation
18+
`install zpm-registry`
1819

1920
## Docker Installation
2021
Build docker container
2122

22-
## ZPM Installation
23-
`install zpm-registry`
23+
## Usual Installation
24+
Import classes from cls and run Installer from Root
2425

2526
# Usage
2627
ZPM Registry exposes REST API, which perfoms listing, publising and deployment services. You can examine the REST in the source class [Registry.cls](https://github.com/intersystems-community/zpm-registry/blob/master/src/cls/ZPM/Registry.cls) or via Swagger
2728

28-
Note, when you publish the repo via API you need to provide the GIthub URL of the repo, which will contain module.xml.
29+
Note, when you publish the repo via API you need to provide the Github URL of the repo, which will contain module.xml.
2930
And published package will remember the repository and will not allow to publish/update package with the same name but with another repository.
3031

3132

3233
## Working With Your Registry From ZPM Client
3334
You can setup ZPM client to work with your registry with the following command:
3435
```
35-
ZPM:USER>repo -n registry -r -url https://registry.yourdomain.com
36+
zpm:USER>repo -n registry -r -url https://registry.yourdomain.com
37+
```
38+
39+
## Settings
40+
To configure the registry, utilize the zpm-registry.yaml file located within the IRIS installation folder. Retrieve the IRIS directory in which the file should reside using the following command: `write ##class(%SYSTEM.Util).InstallDirectory()`.
41+
42+
43+
## Proxy-Registry
44+
Starting from version 1.1.2, zpm-registry includes the Proxy feature.
45+
This allows the IPM client to use only your private registry and install packages from your private registry, all the while retaining the capability to install packages from an external registry (Uplink).
46+
47+
External registries that your local registry can access are called Uplinks. You can define one or more external registries. You can also list which packages from the Uplink registry should be available.
48+
49+
These settings are set in the `zpm-registry.yaml` file.
50+
51+
Settings file example:
52+
```
53+
uplinks:
54+
pm:
55+
url: https://pm.community.intersystems.com/
56+
allow_packages: dsw,zpm*,?u*
57+
```
58+
59+
For more information, see https://community.intersystems.com/post/new-zpm-registry-feature-%E2%80%93-proxy-registry
60+
61+
62+
## Delete packages
63+
Starting from version 0.7, IPM introduces support for the "unpublish" command, which facilitates the removal of a package that was previously published.
64+
In order for this command to be executed, it is necessary to explicitly allow the removal of packages on the side of the registry. To do this, add the line "delete-enabled: true" to the settings file `zpm-registry.yaml`
65+
66+
Settings file example:
67+
```
68+
delete-enabled: true
3669
```
3770

3871

module.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<Name>zpm-registry</Name>
66
<ExternalName>ZPM Registry</ExternalName>
77
<Description>Registry server for ZPM</Description>
8-
<Version>1.2.4</Version>
8+
<Version>1.2.6</Version>
99
<Packaging>module</Packaging>
1010
<Dependencies>
1111
<ModuleReference>

0 commit comments

Comments
 (0)