Skip to content

Commit

Permalink
rebranding
Browse files Browse the repository at this point in the history
  • Loading branch information
fraenki committed Aug 14, 2023
1 parent 002fc6e commit 95179d6
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 37 deletions.
51 changes: 20 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[![Continous Integration](https://github.com/andeman/puppet-baculaweb/actions/workflows/ci.yaml/badge.svg)](https://github.com/andeman/puppet-baculaweb/actions/workflows/ci.yaml)
[![codecov](https://codecov.io/gh/andeman/puppet-baculaweb/branch/main/graph/badge.svg?token=0BoY091pEV)](https://codecov.io/gh/andeman/puppet-baculaweb)
[![Puppet Forge](https://img.shields.io/puppetforge/v/andeman/baculaweb.svg)](https://forge.puppetlabs.com/andeman/baculaweb)
[![Puppet Forge Downloads](http://img.shields.io/puppetforge/dt/andeman/baculaweb.svg)](https://forge.puppetlabs.com/andeman/baculaweb)
[![Continous Integration](https://github.com/markt-de/puppet-baculaweb/actions/workflows/ci.yaml/badge.svg)](https://github.com/markt-de/puppet-baculaweb/actions/workflows/ci.yaml)
[![codecov](https://codecov.io/gh/markt-de/puppet-baculaweb/branch/main/graph/badge.svg?token=0BoY091pEV)](https://codecov.io/gh/markt-de/puppet-baculaweb)
[![Puppet Forge](https://img.shields.io/puppetforge/v/markt/baculaweb.svg)](https://forge.puppetlabs.com/mark/baculaweb)
[![Puppet Forge Downloads](http://img.shields.io/puppetforge/dt/markt/baculaweb.svg)](https://forge.puppetlabs.com/markt/baculaweb)

# baculaweb
# puppet-baculaweb

#### Table of Contents

Expand Down Expand Up @@ -32,44 +32,29 @@
* [Contributing](#contributing)
* [Release Notes](#release-notes)



## Overview

This module install and configures the baculaweb a web based reporting and monitoring tool for Bacula.

You can find the baculaweb documention here: https://www.bacula-web.org/

The module only install and configure the webapp itself. You still require a webserver (nginx or apache) with php.
This module install and configures [Bacula-Web](https://www.bacula-web.org/), a web based reporting and monitoring tool for Bacula.

## Requirements

* Puppet >= 6.0.0
* Bacula-Web 8.6.0 or later (due to breaking changes in this release)
* [puppetlabs/stdlib](https://github.com/puppetlabs/puppetlabs-stdlib)
* [puppet/archive](https://github.com/voxpupuli/puppet-archive)

### Optional Setup Requirements

Recommended modules for apache + php setup:
* [puppetlabs/apache](https://github.com/puppetlabs/puppetlabs-apache)
* [puppet/php](https://github.com/voxpupuli/puppet-php)

The needed requirements for the webserver and for php are documented here:

http://docs.bacula-web.org/en/latest/02_install/requirements.html
* A webservice like Apache or Nginx, [puppetlabs/apache](https://github.com/puppetlabs/puppetlabs-apache) is recommended.
* A supported version of PHP (PHP-FPM is strongly recommended), [puppet/php](https://github.com/voxpupuli/puppet-php) is recommended.

### Beginning with baculaweb
All parameters for the baculaweb module are contained within the main baculaweb class, so for any function of the module, set the options you want. All configuration parameters can be assigned hiera. The default values are also lookuped up by hiera. See the common usages below for examples.

## Usage

### Install and enable baculaweb

```
include baculaweb
```

### Default User and Password for fresh installs

After installation the default user is **admin** and the default password is **password**. You should change this after installation.

See: https://docs.bacula-web.org/en/latest/02_install/finalize.html#reset-user-password
Expand All @@ -79,6 +64,7 @@ The default application.db is only deployed once. Data is persisted between upgr


### Configure bacula catalog databases

To get baculaweb up and running configure at least one bacula catalog database with the paramter catalog_db.

See the following example for the different catalog database types:
Expand Down Expand Up @@ -222,6 +208,7 @@ For a list of supported operating systems, see [metadata.json](metadata.json)
This module uses [puppet_litmus](https://github.com/puppetlabs/puppet_litmus) for running acceptance tests.

### Running acceptance tests

Create test environment:
```
./scripts/create_test_env
Expand All @@ -243,12 +230,15 @@ Remove the test environment:
```

### Running unit tests

```
./scripts/unit_tests
```

## Release module to Puppet Forge

### Prepare

First prepare the release with:

```
Expand All @@ -258,26 +248,25 @@ First prepare the release with:
This will set the version in `metadata.json`, create `REFERENCE.md` and `CHANGELOG.md`.

### Commit and push

Then commit the changes and push them to the repository.

### configure github actions secrets
https://github.com/andeman/puppet-opnsense/settings/secrets/actions

https://github.com/markt-de/puppet-opnsense/settings/secrets/actions

Ensure that the following secrets are set in the github repository:
- FORGE_API_KEY (your puppet forge api key)


### Run github actions release workflow

Then run github actions pipeline "Publish module to puppet forge" from main branch to release the module to the forge:

https://github.com/andeman/puppet-baculaweb/actions/workflows/release.yaml
https://github.com/markt-de/puppet-baculaweb/actions/workflows/release.yaml

## Contributing

Please use the GitHub issues functionality to report any bugs or requests for new features. Feel free to fork and submit pull requests for potential contributions.

All contributions must pass all existing tests, new features should provide additional unit/acceptance tests.

## Release Notes

See [CHANGELOG.md](CHANGELOG.md)
12 changes: 6 additions & 6 deletions metadata.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"name": "andeman-baculaweb",
"name": "markt-baculaweb",
"version": "1.0.0",
"author": "andeman",
"summary": "Puppet module for baculaweb - a web based reporting and monitoring tool for Bacula",
"author": "markt.de",
"summary": "Setup Bacula-Web - a web based reporting and monitoring tool for Bacula",
"license": "Apache-2.0",
"source": "https://github.com/andeman/puppet-baculaweb",
"project_page": "https://github.com/andeman/puppet-baculaweb",
"issues_url": "https://github.com/andeman/puppet-baculaweb/issues",
"source": "https://github.com/markt-de/puppet-baculaweb",
"project_page": "https://github.com/markt-de/puppet-baculaweb",
"issues_url": "https://github.com/markt-de/puppet-baculaweb/issues",
"dependencies": [
{
"name": "puppetlabs/stdlib",
Expand Down

0 comments on commit 95179d6

Please sign in to comment.