diff --git a/README.md b/README.md index dd4d7a7..8038137 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,19 @@ # NLS - NVIDIA License System -- https://docs.nvidia.com/license-system/latest/index.html - [TOC] -# Installation +# Official Docs -## Docker +- - https://docs.nvidia.com/license-system/latest/index.html -1. Install Docker on your system where NLS should run -2. Download latest release (*date of writing `v3.4.1`*) -3. Copy archive (`nls-X.Y.Z-bios.zip`) to your Docker-Server -4. Set version \ - `export VERSION=3.4.1` -5. Extract archive \ - `unzip nls-$VERSION-bios.zip` - `cd nls-$VERSION-bios` -6. Import Images into Docker \ - `docker load --input dls_appliance_$VERSION.tar.gz` \ - `docker load --input dls_pgsql_$VERSION.tar.gz` \ - `docker load --input dls_upgrade_$VERSION.tar.gz` (optional) -7. Goto `docker` directory - `cd docker` -8. Create Envirnoment-File - `touch .env` -9. Add the following line to this file - `echo "DLS_PUBLIC_IP=" > .env` -10. Start Docker-Stack - `docker compose up -d` -11. Show running containers \ - `docker container ls` +# Installation / Docker Setup + +Installation based on Docker can be found [here](doc/DockerSetup.md). # Reverse Engineering Notes -Notes about accessing file structure and database can be found [here](Reverse%20Engineering%20Notes.md). +Notes about accessing file structure and access database can be found [here](doc/ReverseEngineeringNotes.md). -# Debug Information +# Licensing Flow / Process -Debug information about licensing process, token-exchange and certificates can be found [here](DEBUG.md). +Debug information about licensing process, token-exchange and certificates can be found [here](doc/LicensingFlow.md). diff --git a/Database.md b/doc/Database.md similarity index 100% rename from Database.md rename to doc/Database.md diff --git a/doc/DockerSetup.md b/doc/DockerSetup.md new file mode 100644 index 0000000..98051af --- /dev/null +++ b/doc/DockerSetup.md @@ -0,0 +1,24 @@ +# Docker Setup + +1. Install Docker on your system where NLS should run +2. Download latest release (*date of writing `v3.4.1`*) +3. Copy archive (`nls-X.Y.Z-bios.zip`) to your Docker-Server +4. Set version \ + `export VERSION=3.4.1` +5. Extract archive \ + `unzip nls-$VERSION-bios.zip` + `cd nls-$VERSION-bios` +6. Import Images into Docker \ + `docker load --input dls_appliance_$VERSION.tar.gz` \ + `docker load --input dls_pgsql_$VERSION.tar.gz` \ + `docker load --input dls_upgrade_$VERSION.tar.gz` (optional) +7. Goto `docker` directory + `cd docker` +8. Create Environment-File + `touch .env` +9. Add the following line to this file + `echo "DLS_PUBLIC_IP=" > .env` +10. Start Docker-Stack + `docker compose up -d` +11. Show running containers \ + `docker container ls` \ No newline at end of file diff --git a/DEBUG.md b/doc/LicensingFlow.md similarity index 100% rename from DEBUG.md rename to doc/LicensingFlow.md diff --git a/Reverse Engineering Notes.md b/doc/ReverseEngineeringNotes.md similarity index 92% rename from Reverse Engineering Notes.md rename to doc/ReverseEngineeringNotes.md index ef1c1e1..2bc4698 100644 --- a/Reverse Engineering Notes.md +++ b/doc/ReverseEngineeringNotes.md @@ -2,18 +2,17 @@ For this research, NLS Docker-Setup is used. -- More about Docker Images https://git.collinwebdesigns.de/nvidia/nls - [TOC] # Appliance +The instructions assume that Docker and NLS-Stack is installed. + ## Get / Copy file structure -1. Log in to your Docker-Server -2. Create a target directory (e.g. `mkdir /opt/nls-files`) -3. Get the Container-ID of the NLS-Appliance (`docker ps`) -4. Copy files from container \ +1. Create a target directory (e.g. `mkdir /opt/nls-files`) +2. Get the Container-ID of the NLS-Appliance (`docker ps`) +3. Copy files from container \ `docker cp -r ` ## About configuration data diff --git a/docker-image-push.sh b/docker-image-push.sh new file mode 100644 index 0000000..b4083a0 --- /dev/null +++ b/docker-image-push.sh @@ -0,0 +1,16 @@ +#!/bin/bash + +IMAGE_REGISTRY=registry.git.collinwebdesigns.de + +docker image ls + +### Tag Images +#docker image tag $IMAGE_REGISTRY/nvidia/nls/appliance:$VERSION +#docker image tag $IMAGE_REGISTRY/nvidia/nls/pgsql:$VERSION +#docker image tag $IMAGE_REGISTRY/nvidia/nls/upgrade:$VERSION +### Login to private registry +#docker login registry.git.collinwebdesigns.de +### Push images +#docker image push $IMAGE_REGISTRY/nvidia/nls/appliance:$VERSION +#docker image push $IMAGE_REGISTRY/nvidia/nls/pgsql:$VERSION +#docker image push $IMAGE_REGISTRY/nvidia/nls/upgrade:$VERSION