Skip to content

Commit

Permalink
fix: prepare for 5.0.0-15 release
Browse files Browse the repository at this point in the history
  • Loading branch information
moabu committed Jul 14, 2023
1 parent 75a09f1 commit 664553a
Show file tree
Hide file tree
Showing 11 changed files with 38 additions and 5 deletions.
1 change: 0 additions & 1 deletion admin-ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,3 @@ npm run start
Once the project is compiled and started, UI can be accessed at URL: http://localhost:4100

**Note:** Please check this [link](https://raw.githubusercontent.com/0wczar/airframe-react/master/.npmrc) for NPM access token to be added to `NPM_TOKEN` field in `.env` file.

1 change: 1 addition & 0 deletions casa/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
# casa
User-facing dashboard for people to manage authentication and authorization data in the Gluu Server.

2 changes: 1 addition & 1 deletion docker-admin-ui/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ RUN python3 -m ensurepip \
# jans-linux-setup sync
# =====================

ENV JANS_SOURCE_VERSION=4d17cbcdab3272653f2cf547bcef1d8181353ffd
ENV JANS_SOURCE_VERSION=2f3ea45597f941dd69e4e962720e9ffd26fb6b96
ARG JANS_SETUP_DIR=jans-linux-setup/jans_setup

# note that as we're pulling from a monorepo (with multiple project in it)
Expand Down
1 change: 0 additions & 1 deletion docker-admin-ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,4 +120,3 @@ To add plugins to AdminUI, for example `myplugin.zip`

1. Set the name of the plugin (without the extension name) in environment variable `GLUU_ADMIN_UI_PLUGINS`, for example: `GLUU_ADMIN_UI_PLUGINS=myplugin`.
2. Mount `myplugin.zip` to `/app/plugins/myplugin.zip` inside the pod/container. Note that if `/app/plugins/myplugin.zip` is not exist, plugin will be ignored.

2 changes: 1 addition & 1 deletion docker-casa/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ COPY conf/prometheus-config.yaml /opt/prometheus/
# jans-linux-setup sync
# =====================

ENV JANS_SOURCE_VERSION=9c8e510e6571362009b4ca422ab946ba711e0122
ENV JANS_SOURCE_VERSION=2f3ea45597f941dd69e4e962720e9ffd26fb6b96
ARG JANS_SETUP_DIR=jans-linux-setup/jans_setup

# note that as we're pulling from a monorepo (with multiple project in it)
Expand Down
1 change: 1 addition & 0 deletions docker-casa/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,3 +155,4 @@ Hybrid persistence supports all available persistence types. To configure hybrid
"session": "spanner",
}
```

1 change: 1 addition & 0 deletions docker-flex-monolith/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,3 +85,4 @@ Grab a fresh ubuntu 22.04 lts VM and run:
```bash
wget https://raw.githubusercontent.com/GluuFederation/flex/main/automation/startflexmonolithdemo.sh && chmod u+x startflexmonolithdemo.sh && sudo bash startflexmonolithdemo.sh demoexample.gluu.org MYSQL
```

16 changes: 16 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,19 @@ Gluu Flex uses Agama to offer an alternative way to build web-based authenticati
## Support

The Gluu Flex contract includes guaranteed response times and consultative support via our [support portal](https://support.gluu.org).

## Looking for older documentation versions?

The Janssen Project posts the last five versions of the documentation. If you are looking for older versions, you can find them unprocessed in the [docs](https://github.com/JanssenProject/jans/tree/main/docs) folder. Select the version of choice from the tag dropdown in GitHub. If you want to process them you may do so by following the steps below :

### Testing Documentation Changes Locally

While contributing documentation to official Gluu [documentation](https://docs.gluu.org/) it is important to make sure that documents meet [style guidelines](../CONTRIBUTING.md#documentation-style-guide) and have been proofread to remove any typographical or grammatical errors.
Gluu uses [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) to create the documentation site. Before new content is pushed to the repository on GitHub, it should be tested locally by the author. Author can do this by deploying Material for MkDocs locally.

High-level steps involve:

1. [Install Material for MkDocs](https://squidfunk.github.io/mkdocs-material/getting-started/#installation)
2. Install required plugins
3. [Preview as you write](https://squidfunk.github.io/mkdocs-material/creating-your-site/#previewing-as-you-write)

16 changes: 16 additions & 0 deletions docs/install/helm-install/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,19 @@ All these components are deployed using Gluu [helm chart](https://github.com/Glu

You can check the [reference](../../reference/kubernetes/helm-chart.md) guide to view the list of the chart components and values.

## Looking for older helm charts?

If you are looking for older helm charts, you need to build them from the [Gluu Flex](https://github.com/GluuFederation/flex/tree/main/flex-cn-setup/pygluu/kubernetes/templates/helm/gluu) repository. We only keep the last 5 versions of the chart up. We support auto-upgrade using helm upgrade and hence want everyone to stay up to date with our charts.

To build older charts manually from the Gluu Flex repository, you can use the following example which assumes we are building for janssen version `v5.0.0`:

```bash
git clone --filter blob:none --no-checkout https://github.com/GluuFederation/flex.git /tmp/flex \
&& cd /tmp/flex \
&& git sparse-checkout init --cone \
&& git checkout v5.0.0 \
&& git sparse-checkout add flex-cn-setup/pygluu/kubernetes/templates/helm/gluu \
&& cd flex-cn-setup/pygluu/kubernetes/templates/helm/gluu \
&& helm dependency update \
&& helm package .
```
1 change: 1 addition & 0 deletions flex-cn-setup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,4 @@
```

This command will generate executable called `pygluu-kubernetes.pyz` under the same directory.

1 change: 0 additions & 1 deletion flex-linux-setup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,3 @@ Uninstallation of Gluu Flex along with Jans
- Uninstall Flex: `python3 /opt/jans/jans-setup/flex/flex-linux-setup/flex_setup.py --remove-flex`
- Uninstall Jans: `python3 /opt/jans/jans-setup/install.py -uninstall`
- Remove old files from `/var/www/html/` directory

0 comments on commit 664553a

Please sign in to comment.