Regiboxd first steps - Revision history

Regify: /* Uninstall a regiboxd service */

2025-06-23T08:11:49Z

Uninstall a regiboxd service

Regify: /* Creating your first regibox on Windows */

2025-06-23T08:07:05Z

Creating your first regibox on Windows

Regify: /* Creating your first regibox on Windows */

2025-06-11T10:59:58Z

Creating your first regibox on Windows

Regify: /* Creating your first regibox on Windows */

2023-01-23T13:29:14Z

Creating your first regibox on Windows

Regify: /* Creating your first regibox on Windows */

2023-01-23T13:28:40Z

Creating your first regibox on Windows

Regify: /* Creating your first regibox on Windows */

2023-01-23T13:27:14Z

Creating your first regibox on Windows

Regify: /* Creating your first regibox on Windows */

2023-01-23T13:26:37Z

Creating your first regibox on Windows

Regify: /* Uninstall a regiboxd service */

2023-01-23T11:25:47Z

Uninstall a regiboxd service

Regify at 11:20, 23 January 2023

2023-01-23T11:20:51Z

Regify: /* Uninstall a regiboxd service */

2023-01-23T11:17:22Z

Uninstall a regiboxd service

@@ Line 34: / Line 34: @@
 == Uninstall a regiboxd service ==
-In order to unregisters a regiboxd service, call regiboxd with the '''-u''' option:
+In order to unregister a regiboxd service, call regiboxd with the '''-u''' option:
   regiboxd -u "MyExampleRegibox"
@@ Line 46: / Line 46: @@
 '''NOTE:'''<br>If a config is already existing, you can omit the '''-r''' setting like in this example call.
-'''NOTE:'''<br>This unregisters and re-register is also what you should do before updating regiboxd to a new version. Unregister all running regiboxd instances, update your software and re-register the services.
+'''NOTE:'''<br>This unregister and re-register is also what you should do before updating regiboxd to a new version. Unregister all running regiboxd instances, update your software and re-register the services.
 '''NOTE:'''<br>Sometimes you need to start the regiboxd service manually after it was unregistered and re-registered. Use Windows Service management for this. You can also try '''net start MyExampleRegibox'''.

@@ Line 9: / Line 9: @@
 #* '''IMPORTANT:''' Do not use the same folder for configuration and data!
 # Register your regiboxd as service: <pre>c:\Program Files\regiboxd\regiboxd.exe -c "c:\rgbx_config" -r "c:\rgbx_root" -i "MyExampleRegibox"</pre>
 #* Please note that we submit the previously created config folder with '''-c''' and the regibox root folder with '''-r'''.
 #* The '''-i''' switch registers your new regibox as service with the name ''MyExampleRegibox''.
 #* If you don't get ''Service MyExampleRegibox has been successfully installed'', ensure that you run the commandline with administrator permissions.
 # Validate the service by listing all regiboxd services:
 #:<pre>regiboxd -L</pre>

@@ Line 8: / Line 8: @@
 # Create a root folder as root for your regiboxd regiboxes: <pre>mkdir c:\rgbx_root</pre>
 #* '''IMPORTANT:''' Do not use the same folder for configuration and data!
-# Register your regiboxd as service: <pre>regiboxd -c "c:\rgbx_config" -r "c:\rgbx_root" -i "MyExampleRegibox"</pre>
+# Register your regiboxd as service: <pre>c:\Program Files\regiboxd\regiboxd.exe -c "c:\rgbx_config" -r "c:\rgbx_root" -i "MyExampleRegibox"</pre>
 #* Please note that we submit the previously created config folder with '''-c''' and the regibox root folder with '''-r'''.
 #* The '''-i''' switch registers your new regibox as service with the name ''MyExampleRegibox''.
 #* If you don't get ''Service MyExampleRegibox has been successfully installed'', ensure that you run the commandline with administrator permissions.
 # Validate the service by listing all regiboxd services:
 #:<pre>regiboxd -L</pre>

@@ Line 20: / Line 20: @@
 #* It is more easy to control regiboxd using the '''regiboxctl''' tool, which takes care of placing the file and observing the result.
 #* Note that we use an uppercase '''-J''' to provide Windows specific json (see [https://manuals.regify.com/docs/regiboxd/2.1/reference_manual/#_windows_shell_syntax regiboxd manual]).
-#* <pre>regiboxctl -c "c:\rgbx_config" -p -J "{'op':'newConfig', 'providerUrl':'https://bp137.regify.com', 'regifyUser':'user@company.com', 'regifyPass':'password'}"</pre>
+#* <pre>regiboxctl -c "c:\rgbx_config" -p -J "{'op':'newConfig', 'providerUrl':'https://yourProviderDomain.com', 'regifyUser':'user@company.com', 'regifyPass':'password'}"</pre>
 #* You should get some json result showing '''{ "status": "OK" }'''. If you get an error, validate your request.
 # Create your first regibox like this:

@@ Line 8: / Line 8: @@
 # Create a root folder as root for your regiboxd regiboxes: <pre>mkdir c:\rgbx_root</pre>
 #* '''IMPORTANT:''' Do not use the same folder for configuration and data!
-# Install config and windows service for your new regiboxd: <pre>regiboxd -c "c:\rgbx_config" -r "c:\rgbx_root" -i "MyExampleRegibox"</pre>
+# Register your regiboxd as service: <pre>regiboxd -c "c:\rgbx_config" -r "c:\rgbx_root" -i "MyExampleRegibox"</pre>
 #* Please note that we submit the previously created config folder with '''-c''' and the regibox root folder with '''-r'''.
 #* The '''-i''' switch registers your new regibox as service with the name ''MyExampleRegibox''.

@@ Line 3: / Line 3: @@
 # After you downloaded the installer, please run and finish the setup.
 # Open a '''commandline prompt with Administrator permissions'''.
-#* You may want to increase the window size in the shell properties by increasing Screen Buffer Size Width to 160.
+#* You may want to increase the window size in the properties (top left menu) by increasing Screen Buffer Size Width to 160.
 # Go to the root folder of your drive: <pre>cd c:\</pre>
 # Create a directory as your instance folder. It will hold your future regibox configuration: <pre>mkdir c:\rgbx_config</pre>

@@ Line 41: / Line 41: @@
 You can re-register the service at any time on the existing configuration and data like this:
-  <pre>regiboxd -c "c:\rgbx_config" -r "c:\rgbx_root" -i "MyExampleRegibox"</pre>
+  <pre>regiboxd -c "c:\rgbx_config" -i "MyExampleRegibox"</pre>
-'''NOTE:'''<br>This is also what you should do before updating regiboxd to a new version. Unregister all running regiboxd instances, update your software and re-register the services.
+'''NOTE:'''<br>If a config is already existing, you can omit the '''-r''' setting like in this example call.
-'''NOTE:'''<br>Sometimes you need to start the regiboxd service manually after it was unregistered and re-registered. Use Windows Service management for this.
+'''NOTE:'''<br>This unregisters and re-register is also what you should do before updating regiboxd to a new version. Unregister all running regiboxd instances, update your software and re-register the services.
 == Diagnostics ==

← Older revision		Revision as of 11:20, 23 January 2023
Line 46:		Line 46:

	'''NOTE:'''<br>Sometimes you need to start the regiboxd service manually after it was unregistered and re-registered. Use Windows Service management for this.		'''NOTE:'''<br>Sometimes you need to start the regiboxd service manually after it was unregistered and re-registered. Use Windows Service management for this.
		+
		+	== Diagnostics ==
		+
		+	If you were asked to send a diagnostics by regify support or your regify provider support, you can start and stop diagnostics like this:
		+
		+	regiboxctl -c "c:\rgbx_config" -J "{'op':'diagnostics'}"
		+	{"status":"OK","desc":"diagnostics started"}
		+
		+	To stop it, run the same again
		+
		+	regiboxctl -c "c:\rgbx_config" -J "{'op':'diagnostics'}" -t 60
		+	{"status":"OK","desc":"Diagnostics written to c:/rgbx_config/lib/tmp/regibox-diagnostics.zip"}

	== Debugging / Logfile ==		== Debugging / Logfile ==

@@ Line 43: / Line 43: @@
   <pre>regiboxd -c "c:\rgbx_config" -r "c:\rgbx_root" -i "MyExampleRegibox"</pre>
-NOTE: This is also what you should do before updating regiboxd to a new version. Unregister all running regiboxd instances, update your software and re-register the services.
+'''NOTE:'''<br>This is also what you should do before updating regiboxd to a new version. Unregister all running regiboxd instances, update your software and re-register the services.
 == Debugging / Logfile ==