Are there any better FusionPBX docs?

[jwrite]

So I've been tinkering with FusionPBX for the last couple months and one thing that always gets me is the lack of documentation and poor documentation.

For example, if you're looking at https://docs.fusionpbx.com/en/latest/advanced/default_settings/provision.html it specifies that in order to user Provisioning you must have the following set:

• enabled: Must be enabled and set to value true and enabled True. It is disabled by default.
• http_auth_username: Must be enabled and set to value true and enabled True. It is disabled by default. Be sure to use a strong username.
• http_auth_password: Must be enabled and set to value true and enabled True. It is disabled by default. Be sure to use a strong password.

The first one, enabled, is pretty straight forward. Set enabled value to true and make sure it's enabled. Got it, even though enabled expects a text type and probably should have been a bool type but we'll give it that..

The next two say that http_auth_username and http_auth_password must both be set to a value of true and that both should be enabled.. Got it.. based on the first step, even though it's expecting a text type we can set the value to true, but wait... at the end it says be sure to use a strong username or strong password... So am I supposed to put in the value true or a strong username?? Because lower in the table it shows a value of admin for http_auth_username and a value of 555 for http_auth_password.

There are many such instances that I run across. Also when looking at the default settings there are countless variables that don't have any documentation, such as:

Default Setting Subcategory	Default Setting Name	Default Setting Value	Default Setting Enabled	Default Setting Description
cidr	array	209.210.17.193/32	FALSE
http_auth_username	text	admin	TRUE
http_auth_type	text	digest	TRUE
enabled	text	TRUE	TRUE
cidr	array	209.210.16.196/32	FALSE
auto_insert_enabled	boolean	TRUE	FALSE
http_auth_disable	boolean	FALSE	FALSE
admin_name	text		FALSE
admin_password	text		FALSE
http_domain_filter	boolean	TRUE	TRUE
number_as_presence_id	text	TRUE	TRUE
http_auth_password	array	555	TRUE

But all the descriptions are empty.. Some are self explanatory but it would still be nice to have a line like "enabled, Required to enable auto provisioning", or "http_auth_password, Strong password that will be used to restrict access to provisioning files.", or "http_domain_filter, only makes device provisioning files available on the tenants domain".

This still leaves unanswered questions such as, if I disable http_domain_filter and customize a different http_auth_username & http_auth_password for a tenant will the config of that file only be available to devices authenticating with that username & password or will anyone that authenticated be authorized to download the device config?

It would also be nice to see what some options are for the settings, such as for http_auth_type is set to digest by default, but is that the only available option or can you select basic, bearer, oauth, ntlm? I would guess that oauth and ntlm are not supported but what about basic or bearer?

I know that someone can spend 10 times the amount of time Google searching this stuff, but it seems like many of theses are common questions that are asked through out the forum, so does anyone know if there is a more comprehensive guide or better help docs to FusionBPX?

Thanks in advance!

 

[ad5ou]

The documentation is open source so you are free to submit a pull request with improvements. That being said, there IS better documentation including videos from past training classes available at fusionpbx.com but is part of the paid member packages so not available for free.

 

[hfoster]

Only criticism I have with the usual open source rebuff is that typically unless you wrote the feature, you won't know how to document it, and if you know how to figure out how to document the feature then you probably stop caring about the documentation.

Speaking of which, this reminds me that I probably still need to do a pull request for a few broken templates I've spotted. I might have a look over the documentation too.

 

[jwrite]

I would love to make some pull requests but it's not uncommon to see pull requests dating back years from other contributors so I sometimes wonder whether it will ever be heard.