Skip to content

Commit

Permalink
0.6.9 changelog, other docs fixes and improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
@BelleNottelling
BelleNottelling committed Jan 9, 2024
1 parent 8d8c4ba commit ca15b68
Show file tree
Hide file tree
Showing 5 changed files with 59 additions and 36 deletions.
21 changes: 21 additions & 0 deletions pages/docs/changelog.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,27 @@ Below are the changelogs for all FOSSBilling releases ordered most recent to old

Dates are displayed as `MM-DD-YYYY`.

## 0.6.9 (1-8-2024)

This release incorporates some enhancements to the client area and some other minor improvements.

For those of you who are upgrading from versions older than 0.6.0, please check [the changelog](https://fossbilling.org/docs/changelog#060-12-11-2023) for that release as well as it included some major changes, including backwards-incompatible ones.

### 🐛 Bug Fixes

- Fixed some minor front-end issues for the client area.
- The WHM server manager now has additional checks to ensure invalid usernames won't be generated.

### 📈 Enhancements

- Improved the visual consistency of the client area.
- The admin panel login page will now respect the choice between light & dark mode.
- The side menu items in the client area will now be added to the mobile hamburger menu to ensure mobile users won't have reduced functionality.
- Some minor improvements to logging have been made.
- Errors while trying to deliver errors are now sent to a new "email" log channel for easier visibility.
- When a session fails the fingerprint check & is destroyed, a warning will be sent to the PHP error log.
- Added a new config option to disable session fingerprinting.

## 0.6.8 (1-4-2024)

This is a minor update to address an issue with the installer and bring some quality of life improvements.
Expand Down
4 changes: 0 additions & 4 deletions pages/docs/faq/error-reporting.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ import { FontAwesomeIcon } from '@fortawesome/react-fontawesome'
import { faCode, faPersonDigging } from '@fortawesome/free-solid-svg-icons'
import { Callout } from 'nextra-theme-docs'

<Callout type="info" emoji={<FontAwesomeIcon icon={faPersonDigging} />}>
This documentation references a new features that is currently available in FOSSBilling preview builds and will be generally available in FOSSBilling version 0.6.0.
</Callout>

# What is error reporting?

FOSSBilling includes the optional functionality to incorporate error reporting. Error reporting is handled via [Sentry.io](https://sentry.io/welcome/) with data being recorded in a [secure and compliant](https://sentry.io/security/) manner with a maximum retention of 90 days.
Expand Down
62 changes: 35 additions & 27 deletions pages/docs/faq/index.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,14 @@ If you're interested in quick overview of the significant differences between th

At a very quick glance, here are some of the important differences between the two:

| Comparison Categories | BoxBilling | FOSSBilling |
|----------|------------|-------------|
|Last Release | ![GitHub Release Date - Published_At](https://img.shields.io/github/release-date/boxbilling/boxbilling?style=for-the-badge&logo=github&logoColor=black&label=Last%20release) | ![GitHub Release Date](https://img.shields.io/github/release-date/fossbilling/fossbilling?style=for-the-badge&logo=github&logoColor=black&label=Last%20release) |
|Development| ![GitHub commit activity](https://img.shields.io/github/commit-activity/y/boxbilling/boxbilling?style=for-the-badge) | ![GitHub commit activity](https://img.shields.io/github/commit-activity/y/fossbilling/fossbilling?style=for-the-badge) |
|PHP Support | 7.4 & 8.0| [Officially Supported Versions](https://www.php.net/supported-versions.php) |
| Average Vulnerability Resolution Time* | 71 Days | 6 Days |
| Internationalization** | Mixed | Good |
| Security Features*** | Very Outdated | Good and Constantly Improving |

| Comparison Categories | BoxBilling | FOSSBilling |
| --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Last Release | ![GitHub Release Date - Published_At](https://img.shields.io/github/release-date/boxbilling/boxbilling?style=for-the-badge&logo=github&logoColor=black&label=Last%20release) | ![GitHub Release Date](https://img.shields.io/github/release-date/fossbilling/fossbilling?style=for-the-badge&logo=github&logoColor=black&label=Last%20release) |
| Development | ![GitHub commit activity](https://img.shields.io/github/commit-activity/y/boxbilling/boxbilling?style=for-the-badge) | ![GitHub commit activity](https://img.shields.io/github/commit-activity/y/fossbilling/fossbilling?style=for-the-badge) |
| PHP Support | 7.4 & 8.0 | [Officially Supported Versions](https://www.php.net/supported-versions.php) |
| Average Vulnerability Resolution Time\* | 71 Days | 6 Days |
| Internationalization\*\* | Mixed | Good |
| Security Features\*\*\* | Very Outdated | Good and Constantly Improving |

\*Based on published vulnerability reports only.

Expand All @@ -39,15 +38,15 @@ At a very quick glance, here are some of the important differences between the t
Yes, although we've made significant changes compared to BoxBilling and a migration may not go 100% smoothly.
Create a backup of your filesystem and database and then follow the [migration guide](https://fossbilling.org/docs/getting-started/migrate-from-boxbilling).

Please also be aware that any extensions and themes that were creatd for BoxBilling are **very** unlikely to work in FOSSBilling without modification.
Please also be aware that any extensions and themes that were created for BoxBilling are outright incompatible with FOSSBilling without first being updated.

## Is FOSSBilling stable?

FOSSBilling is very much a work in progress. Right now we are busy squashing a lot of bugs, improving security, and at the same time working on a major rewrite of large sections of the codebase.
FOSSBilling is very much a work in progress. Right now we are busy squashing a lot of bugs, improving security, and at the same time working on a major rewrite of large sections of the codebase.

Right now, FOSSBilling is in a far more stable and secure state than it was just a few months ago and definitely more secure than the last releases of BB were. We don't generally recommend using it on production sites just yet unless you know what you are doing, but as long as you have some basic understanding then you probably could. If you do, then please be aware that there may be breaking changes somewhere in the near future, even though we aim to make migration to future versions as easy as possible.
Right now, FOSSBilling is in a far more stable and secure state than it was just a few months ago and definitely more secure than the last releases of BB were. We don't generally recommend using it on production sites just yet unless you know what you are doing, but as long as you have some basic understanding then you probably could. If you do, then please be aware that there may be breaking changes somewhere in the near future, even though we aim to make migration to future versions as easy as possible.

If you are using it in a production environment then please download and use the latest stable release from the [FOSSBilling website](https://fossbilling.org/downloads) or [GH releases](https://github.com/FOSSBilling/FOSSBilling/releases), and DO NOT use the latest pre-release commits, unless they fix an explicit issue you are facing and you are sure they do not introduce any new issues. As always, backup and test things in a staging environemnt.
If you are using it in a production environment then please download and use the latest stable release from the [FOSSBilling website](https://fossbilling.org/downloads) or [GH releases](https://github.com/FOSSBilling/FOSSBilling/releases), and DO NOT use the latest pre-release commits, unless they fix an explicit issue you are facing and you are sure they do not introduce any new issues. As always, backup and test things in a staging environment.

There is no definite timeline for the 1.0 (production ready) release but you can keep track of progress using the [project roadmap on GitHub](https://github.com/orgs/FOSSBilling/projects/2/views/8).

Expand All @@ -61,25 +60,25 @@ You can [search for existing feature requests](https://github.com/FOSSBilling/FO

### But WHMCS does it already, why doesn't FOSSBilling?

There are two reasons, the first is that FOSSBilling was never intended to be a clone of WHMCS and doesn't always aim to have feature parity with it. Just because something is the popular solution doesn't mean that everything it does is the right or the only way.
There are two reasons, the first is that FOSSBilling was never intended to be a clone of WHMCS and doesn't always aim to have feature parity with it. Just because something is the popular solution doesn't mean that everything it does is the right or the only way.

The second reason is that WHMCS is a commercial (and increasingly expensive) product that has been around for over 20 years with a (presumably) decently paid team of full time developers working on it, and a large ecosystem of third party module providers. FOSSBilling is FOSS without a paid team and with a very limited nubmer of community contributed modules to date.
The second reason is that WHMCS is a commercial (and increasingly expensive) product that has been around for over 20 years with a (presumably) decently paid team of full time developers working on it, and a large ecosystem of third party module providers. FOSSBilling is FOSS without a paid team and with a very limited number of community contributed modules to date.

## Does FOSSBilling work with Pterodactyl?

FOSSBilling does not support Pterodactyl and we currently have no plans to provide official support for it. Just to repeat for absolute clarity, there are **no plans** now or in the future for official support for a Pterodactyl integration. However the community is more than welcome to build an integration of their own for FOSSBilling. Also see [here](https://fossbilling.org/docs/server-managers/others)

## Do I need to pay for FOSSBilling?

No, you do not and never will need to pay to use the core components of FOSSBilling.
No, you do not and never will need to pay to use the core components of FOSSBilling.

The clue is right there in the name: **FOSS** stands for Free and Open Source Software. It means that the source code of the software is open for anyone to freely use, study and modify. If you want to know more about the principles and history of Free and Open Source Software then the [Wikipedia aticle](https://en.wikipedia.org/wiki/Free_and_open-source_software) is actually a really good place to start.
The clue is right there in the name: **FOSS** stands for Free and Open Source Software. It means that the source code of the software is open for anyone to freely use, study and modify. If you want to know more about the principles and history of Free and Open Source Software then the [Wikipedia aticle](https://en.wikipedia.org/wiki/Free_and_open-source_software) is actually a really good place to start.

Third parties are free to develop commercial modules/extensions for FOSSBilling which they may charge for but the basic software will always remain free in all senses of the word.
Third parties are free to develop commercial modules/extensions for FOSSBilling which they may charge for but the basic software will always remain free in all senses of the word.

If you use and appreciate FOSSBilling and you do want to give something back then you are very welcome to sponsor the project with a financial donation or to contribute in other ways.

## How can I contribute to FOSSBilling?
## How can I contribute to FOSSBilling?

Whether open-source projects live or die completely depends on community participation and involvement. This one is no exception, so we appreciate and welcome every contribution.

Expand All @@ -89,22 +88,31 @@ You can find out more about how to do all of those things here: [Contributing to

## How can I sponsor or donate to FOSSBilling?

We are always happy to recieve financial support, whether it is just one time or a recurring donation. You can donate money to the FOSSBilling project using either our [GitHub Sponsors](https://github.com/sponsors/FOSSBilling) or [Open Collective](https://opencollective.com/fossbilling) pages. Funds collected through GitHub are regularly paid out to the Open Collective account so that it all ends up in the same place.
We are always happy to receive financial support, whether it is just one time or a recurring donation. You can donate money to the FOSSBilling project using either our [GitHub Sponsors](https://github.com/sponsors/FOSSBilling) or [Open Collective](https://opencollective.com/fossbilling) pages. Funds collected through GitHub are regularly paid out to the Open Collective account so that it all ends up in the same place.

## What is money donated to FOSSBilling used for?

Money that is donated to the project is used to buy tools and services that are essential for the continuing development of the project, e.g. software licenses. Currently all of the project hosting needs are being met by using free services or being donated to the project by individuals and companies and these are not being paid for with the accumulated donated funds.
Money that is donated to the project is used to buy tools and services that are essential for the continuing development of the project, e.g. software licenses. Currently all of the project hosting needs are being met by using free services or being donated to the project by individuals and companies and these are not being paid for with the accumulated donated funds.

Additionally funds may be used to pay individuals for development hours which are outside of what they would normally be able to give to the project for free, in these cases it will be for blocks of time to complete specific tasks, i.e. large tasks that are relase blocking or developing a specific feature.
Additionally funds may be used to pay individuals for development hours which are outside of what they would normally be able to give to the project for free, in these cases it will be for blocks of time to complete specific tasks, i.e. large tasks that are release blocking or developing a specific feature.

All of the expenses that are paid out, together with descriptions, are publically visible on the [FOSSBilling Open Collective page](https://opencollective.com/fossbilling).
All of the expenses that are paid out, together with descriptions, are publicly visible on the [FOSSBilling Open Collective page](https://opencollective.com/fossbilling).

## I've installed FOSSBilling and it doesn't work, what should I do?

A lot of the time things not working is down to server configuration issues, most commonly with .htaccess or nginx config.
A lot of the time things not working is down to server configuration issues, most commonly with .htaccess or nginx config files.

Many problems can be solved by referring to the instructions in the [Troubleshooting section](https://fossbilling.org/docs/troubleshooting) of this documentation, and that should be the first place you look for a solution.

If you can't resolve your problem using the troubleshooting instructions, then try searching for your specific issue on the [FOSSBilling Forum](https://forum.fossbilling.org/) or in the [Official Discord](https://fossbilling.org/discord), and if you can't find the answer there, then feel free to reach out using either the forum or the Discord server and the community will do their best to help you.

If you believe that the cause of your problem is a bug in FOSSBilling rather than any kind of config or setup error, then please [open an issue on Github](https://github.com/FOSSBilling/FOSSBilling/issues) and report it.

## Where can I find (error) logs?

Many problems can be solved by referring to the instructions in the [Troubleshooting section](https://fossbilling.org/docs/troubleshooting) of this documentation, and that should be the first place you look for a solution.
FOSSBilling uses the `/data/log` directory for logging.

If you can't resolve your problem using the troubleshooting instructions, then try searching for your specific issue on the [FOSSBilling Forum](https://forum.fossbilling.org/) or in the [Official Discord](https://fossbilling.org/discord), and if you can't find the answer there, then feel free to reach out using either the forum or the Discord server and the commmunity will do their best to help you.
In this directory you'll find a file named `php_error.log` which will contain PHP errors (and some other logging statements), however there are also that there are various directories in that folder.

If you believe that the cause of your problem is a bug in FOSSBilling rather than any kind of config or setup error, then please [open an issue on Github](https://github.com/FOSSBilling/FOSSBilling/issues) and report it.
These directories represent specific logging channels and can contain errors, warnings, general information, or alerts.
The logs in these channels are automatically rotated daily and up to 90 days of logs will be retained.
2 changes: 1 addition & 1 deletion pages/docs/getting-started/installation.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ After completing the steps inside of the FOSSBilling installer, you just need to

FOSSBilling relies on the cronjob to perform important actions such as handling renewals, expired orders, sending emails, and more. Because of this, it's critical that cron is configured correctly, is running reliably, and that it's setup to run frequently enough.

We recommend configuring cron to run once ever 5 minutes. If 15 minutes goes past without cron executing, FOSSBilling will display a notification in the administrator panel. If you see this message, you need to resolve the issue as soon as possible.
We recommend configuring cron to run once every 5 minutes. If 15 minutes goes past without cron executing, FOSSBilling will display a notification in the administrator panel. If you see this message, you need to resolve the issue as soon as possible.
![FOSSBilling warning about cron execution](/img/guides/install/cron-warning.png)

#### Utilizing a local cronjob
Expand Down
6 changes: 2 additions & 4 deletions pages/docs/troubleshooting.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
---
title: Troubleshooting
---

# Common problems and their solutions

When troubleshooting, you may need to reference logs generated by FOSSBilling. The location of these files can be found on our [FAQ](https://fossbilling,org/docs/faq#where-can-i-find-error-logs).

## HTTP Error 404

### Subfolder installations
Expand Down

0 comments on commit ca15b68

Please sign in to comment.