opensourcemirror
/
opnsense-ui_devtools
mirror of https://github.com/opnsense/ui_devtools.git
1
0
Fork 0
Code Issues Releases Wiki Activity

explain how to use configd locally as well to test template generation and service control.

This commit is contained in:
Ad Schellevis 2018-04-14 10:50:04 +02:00
parent 683fcaf96e
commit 45f4a43f16
1 changed files with 48 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@ -54,3 +54,51 @@ php run_server.php
```
Finally point your browser to http://localhost:8000/ and test your ui software.
Using configd locally [*nix only]
========================================
To test drive template generation and command execution, it can be practical to have a configd instance running as well on your local machine.
In most cases paths will differ on a development machine, but being able to generate templates and execute commands may help the development process.
The documentation for configd itself can be found [here](https://docs.opnsense.org/development/backend.html)
First step is to copy all the files in our service directory to your development location (the example below assumes current working directory):
```
rsync -avz /<path_to_core>/src/opnsense/service/* configd
cd configd
mkdir tmp
```
Next edit *conf/configd.conf* and change pid and socket location to something writeable from the current user.
To control where the templates are generated and which config it will use, you can edit the template configuration and change the config and root attributes in all sections
In *conf/actions.d/actions_template.conf* change:
* config --> to our config to use
* root --> where to write our template output
Finally let's spin up the configd process in a console (install missing python plugins using pip, when you are unable to start the process):
```
python configd.py console
```
Symlink the socket to the expected location (which OPNsense uses) so both our UI and command
line tools can reach it:
```
sudo ln -s /<install location>/configd/tmp/configd.socket /var/run/configd.socket
```
And check it's status in a new console, using:
```
python configd_ctl.py configd actions
```
Which should display a list of registered commands.
Finally make sure you disable **simulate_mode** in the **config.local.php** of your
local server (restart to apply changes).