Managing FreeBSD systems often means diving into configuration files like /etc/rc.conf. But let's face it: debugging misconfigurations can be a tedious task. Enter checkrc, a command-line tool designed to validate your rc.conf file and ensure your system boots as expected. No more relying on sh -n /etc/rc.conf && echo $? for cryptic error codes. With checkrc, you'll receive clear and actionable feedback about your configuration.

Why Use checkrc? 🛠️

FreeBSD's /etc/rc.conf is the backbone of its startup system. Errors in this file can lead to unexpected behaviours or even failed boot processes. checkrc simplifies validation by:

• Ensuring each configuration setting matches a predefined set of valid values.
• Providing clear feedback instead of cryptic error messages.
• Streamlining the debugging process for sysadmins and developers alike.

Getting Started 💡

To get started quickly, download the pre-built binary from the v1.0.0 release and run it directly on your FreeBSD system:

./checkrc /etc/rc.conf

Expected Output

If everything checks out, you’ll see:

Config check passed successfully.

If errors are found, checkrc will provide detailed information to help you quickly resolve the issues.

Contributing to checkrc 🌟

We’re excited to welcome contributions from the community! Whether you’re squashing bugs, adding new features, or sharing ideas, your help makes checkrc better.

How to Contribute

1. Fork and Clone the Repo Start by forking the project on GitHub and cloning it locally:

   git clone https://github.com/scovl/checkrc.git

1. Create a Feature Branch Keep your changes isolated with a dedicated branch:

   git checkout -b your-feature-branch

1. Build the Project Compile the project using FreeBSD’s make to ensure everything works:

   make

1. Make Your Changes Add your enhancements, then commit them:

   git add .
   git commit -m "Add an amazing feature"

1. Push and Submit a Pull Request Push your branch to your fork:

   git push origin your-feature-branch

Open a Pull Request (PR) on the main checkrc repository.

1. Collaborate and Refine Work with us to refine your submission, address feedback, and celebrate your contribution!

Join the Community 🤝

Have questions or suggestions? Open an issue on our GitHub repository, and let’s discuss it! Together, we can make checkrc an essential tool for every FreeBSD user.

🔗 Repository: GitHub - scovl/checkrc