Merge pull request #92 from kellerkinderDE/noticket/docChanges

doc changes/updates
kellerkinderDE · Feb 7, 2024 · ec633e3 · ec633e3
2 parents c1ae8e1 + 57eb4e8
commit ec633e3
Show file tree

Hide file tree

Showing 9 changed files with 132 additions and 123 deletions.
diff --git a/.github/workflows/test_examples.yml b/.github/workflows/test_examples.yml
@@ -45,7 +45,7 @@ jobs:
       - name: Test ${{ matrix.manifest }} example
         run: |
           cd ${GITHUB_WORKSPACE}/examples/${{ matrix.manifest }}
-          sed -i "s,url: github:kellerkinderDE/devenv-shopware?ref=v2.1.0,url: path:${GITHUB_WORKSPACE}," devenv.yaml
+          sed -i "s,url: github:kellerkinderDE/devenv-shopware?ref=v2.1.1,url: path:${GITHUB_WORKSPACE}," devenv.yaml
           echo running on ${GITHUB_REPOSITORY} with ref ${GITHUB_REF_NAME}
           direnv allow && direnv reload
           devenv ci -vvv

diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,5 @@
 # Devenv
 /.devenv*
 /devenv.lock
+/examples/**/.devenv*
+/examples/**/.direnv
diff --git a/devenv.nix b/devenv.nix
@@ -2,7 +2,7 @@
 let
   cfg = config.kellerkinder;
 
-  currentVersion = "v2.1.0";
+  currentVersion = "v2.1.1";
 
   listEntries = path:
     map (name: path + "/${name}") (builtins.attrNames (builtins.readDir path));

diff --git a/docs/Home.md b/docs/Home.md
@@ -13,6 +13,8 @@ Add the following files to the project `.gitignore` file:
 # Options
 A full list of options can be found [here](Options.md).
 
+If you encounter errors with the standard http/https ports, you should adjust these via the [options](Options-Ports.md).
+
 # Different PHP versions
 If you want to use a specific PHP version, you can set the following versions
 in your project `devenv.nix` file. The php.ini configuration is >php80 specific

diff --git a/docs/Options-Ports.md b/docs/Options-Ports.md
@@ -0,0 +1,119 @@
+# kellerkinder.httpPort
+Sets the http port for caddy.
+
+_This has to be an int_
+
+*_Example_*
+```
+kellerkinder.httpPort = 8080;
+```
+
+# kellerkinder.httpsPort
+Sets the https port for caddy.
+
+_This has to be an int_
+
+*_Example_*
+```
+kellerkinder.httpsPort = 8443;
+```
+
+# kellerkinder.mysqlPort
+Sets the MySQL port.
+
+_This has to be an int_
+
+*_Example_*
+```
+kellerkinder.mysqlPort = 3307;
+```
+
+# kellerkinder.adminerPort
+Sets the Adminer port.
+
+_This has to be an int_
+
+*_Example_*
+```
+kellerkinder.adminerPort = 8010;
+```
+
+# kellerkinder.mailhogApiPort
+Sets the Mailhog API port.
+
+_This has to be an int_
+
+*_Example_*
+```
+kellerkinder.mailhogApiPort = 8025;
+```
+
+# kellerkinder.mailhogSmtpPort
+Sets the Mailhog SMTP port.
+
+_This has to be an int_
+
+*_Example_*
+```
+kellerkinder.mailhogSmtpPort = 1025;
+```
+
+# kellerkinder.mailhogUiPort
+Sets the Mailhog Web UI port.
+
+_This has to be an int_
+
+*_Example_*
+```
+kellerkinder.mailhogUiPort = 8025;
+```
+
+# kellerkinder.redisPort
+Sets the Redis port.
+
+_This has to be an int_
+
+*_Example_*
+```
+kellerkinder.redisPort = 6379;
+```
+
+# kellerkinder.elasticsearchPort
+Sets the Elasticsearch/OpenSearch port.
+
+_This has to be an int_
+
+*_Example_*
+```
+kellerkinder.elasticsearchPort = 9200;
+```
+
+# kellerkinder.elasticsearchTcpPort
+Sets the Elasticsearch/OpenSearch TCP port.
+
+_This has to be an int_
+
+*_Example_*
+```
+kellerkinder.elasticsearchTcpPort = 9300;
+```
+
+# kellerkinder.rabbitMqPort
+Sets the RabbitMQ port.
+
+_This has to be an int_
+
+*_Example_*
+```
+kellerkinder.rabbitMqPort = 5672;
+```
+
+# kellerkinder.rabbitMqManagementPluginPort
+Sets the RabbitMQ management plugin port.
+
+_This has to be an int_
+
+*_Example_*
+```
+kellerkinder.rabbitMqManagementPluginPort = 15672;
+```
diff --git a/docs/Options.md b/docs/Options.md
@@ -166,122 +166,6 @@ Enables the MySQL Binary Log and adds configuration for it.
 kellerkinder.enableMysqlBinLog = false;
 ```
 
-# kellerkinder.httpPort
-Sets the http port for caddy.
 
-_This has to be an int_
-
-*_Example_*
-```
-kellerkinder.httpPort = 8080;
-```
-
-# kellerkinder.httpsPort
-Sets the https port for caddy.
-
-_This has to be an int_
-
-*_Example_*
-```
-kellerkinder.httpsPort = 8443;
-```
-
-# kellerkinder.mysqlPort
-Sets the MySQL port.
-
-_This has to be an int_
-
-*_Example_*
-```
-kellerkinder.mysqlPort = 3307;
-```
-
-# kellerkinder.adminerPort
-Sets the Adminer port.
-
-_This has to be an int_
-
-*_Example_*
-```
-kellerkinder.adminerPort = 8010;
-```
-
-# kellerkinder.mailhogApiPort
-Sets the Mailhog API port.
-
-_This has to be an int_
-
-*_Example_*
-```
-kellerkinder.mailhogApiPort = 8025;
-```
-
-# kellerkinder.mailhogSmtpPort
-Sets the Mailhog SMTP port.
-
-_This has to be an int_
-
-*_Example_*
-```
-kellerkinder.mailhogSmtpPort = 1025;
-```
-
-# kellerkinder.mailhogUiPort
-Sets the Mailhog Web UI port.
-
-_This has to be an int_
-
-*_Example_*
-```
-kellerkinder.mailhogUiPort = 8025;
-```
-
-# kellerkinder.redisPort
-Sets the Redis port.
-
-_This has to be an int_
-
-*_Example_*
-```
-kellerkinder.redisPort = 6379;
-```
-
-# kellerkinder.elasticsearchPort
-Sets the Elasticsearch/OpenSearch port.
-
-_This has to be an int_
-
-*_Example_*
-```
-kellerkinder.elasticsearchPort = 9200;
-```
-
-# kellerkinder.elasticsearchTcpPort
-Sets the Elasticsearch/OpenSearch TCP port.
-
-_This has to be an int_
-
-*_Example_*
-```
-kellerkinder.elasticsearchTcpPort = 9300;
-```
-
-# kellerkinder.rabbitMqPort
-Sets the RabbitMQ port.
-
-_This has to be an int_
-
-*_Example_*
-```
-kellerkinder.rabbitMqPort = 5672;
-```
-
-# kellerkinder.rabbitMqManagementPluginPort
-Sets the RabbitMQ management plugin port.
-
-_This has to be an int_
-
-*_Example_*
-```
-kellerkinder.rabbitMqManagementPluginPort = 15672;
-```
+# Ports
+The configurable ports can be found [here](Options-Ports.md)
diff --git a/docs/Update.md b/docs/Update.md
@@ -16,10 +16,12 @@
     ...
   ```
 * The following configuration types have been changed from `string` to `ìnt`: `kellerkinder.httpPort` and `kellerkinder.httpsPort`
+  * This is also the case for every other port configuration
 * For stability reasons, we use the stable branch `nixos-23.11` instead of `nixos-unstable` in our examples.
 
 ## v2.0.0
-* If you still want to use custom ports, take a look at the [options](Options.md#kellerkinder-httpPort).
+* We changed the default ports for `http` to `80` and `https` to `443`
+  * If you still want to use custom ports, take a look at the [options](Options-Ports.md#kellerkinder-httpPort).
 * You have to adjust your `devenv.yaml` to
   ```yml
     ...

diff --git a/examples/sw5/devenv.yaml b/examples/sw5/devenv.yaml
@@ -5,7 +5,7 @@ inputs:
   nixpkgs:
     url: github:NixOS/nixpkgs/nixos-23.11
   kellerkinder:
-    url: github:kellerkinderDE/devenv-shopware?ref=v2.1.0
+    url: github:kellerkinderDE/devenv-shopware?ref=v2.1.1
     flake: false
   phps:
     url: github:fossar/nix-phps

diff --git a/examples/sw6/devenv.yaml b/examples/sw6/devenv.yaml
@@ -5,7 +5,7 @@ inputs:
   nixpkgs:
     url: github:NixOS/nixpkgs/nixos-23.11
   kellerkinder:
-    url: github:kellerkinderDE/devenv-shopware?ref=v2.1.0
+    url: github:kellerkinderDE/devenv-shopware?ref=v2.1.1
     flake: false
   froshpkgs:
     url: github:FriendsOfShopware/nur-packages