https://github.com/antonvanassche/confiscan

ConfiScan - Collect basic information about Linux systems within seconds.
https://github.com/antonvanassche/confiscan

automation bash linux

Last synced: 3 months ago
JSON representation

ConfiScan - Collect basic information about Linux systems within seconds.

• Host: GitHub
• URL: https://github.com/antonvanassche/confiscan
• Owner: AntonVanAssche
• License: gpl-3.0
• Created: 2024-06-11T16:07:09.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-06-19T17:36:38.000Z (about 2 years ago)
• Last Synced: 2025-01-08T10:12:44.554Z (over 1 year ago)
• Topics: automation, bash, linux
• Language: Shell
• Homepage:
• Size: 73.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          


    


        ConfiScan

    

    


        Collect basic information about Linux systems within seconds.

        


        ·

        Report Bug

        ·

        Request Feature

    

    


        

            

        

        

            

        

        

            

        

        

            

        

        

            

        

        

            

        





## About ConfiScan

> :warning: Currently, only Debian is supported. Support for other Linux distributions will be added soon.

**ConfiScan** is a Bash script designed to collect basic information about Linux systems and output it into a set of organized files (CSV and txt). This tool is intended to assist system administrators in documenting and managing their infrastructure, providing a clear and comprehensive overview of system configurations.

The tool was initially developed as part of a bachelor thesis aimed at exploring solutions to facilitate the transition to Infrastructur as Code environments. Recognizing the ongoing challenges that many small and medium-sized enterprises (SMEs) face, such as limited knowledge, time, and budget constraints, ConfiScan will continue to be developed within this repository. It provides a straightforward and effective method for collecting and organizing system information, simplifying the creation of a comprehensive configuration inventory.

More information about the initial script and backstory can be found at the [repository containing the thesis](https://github.com/AntonVanAssche/hogent-bachelorproef/).

## Usage

### Prerequisites

To use ConfiScan, you need the following:

- Packages:

    - `dmidecode`

    - `net-tools`

- Sudo privileges to execute system commands.

### Execution

```console

$ confiscan.sh -h

Usage: confiscan.sh [OPTION] [CONFIG_FILES]

Options:

    -h   Display help

    -v   Display version

    -f   Force overwrite of output directory/tarball

    -o   Specify output directory, default is hostname-configs

    -t   Create tarball of output directory

Note:

    Shell globbing is supported for [CONFIG_FILES]. They can be files or directories.

Examples:

    confiscan.sh -h

    confiscan.sh /etc/sysctl.conf

    confiscan.sh /etc/apache2/ /etc/sysctl.conf

    confiscan.sh -f -t /etc/machine-id

    confiscan.sh -o /path/to/output_dir

    confiscan.sh -t /etc/bash{.bashrc,_completion}

    confiscan.sh -t

```

## Contributions

Contributions are welcome! Refer to [`CONTRIBUTING.md`](./CONTRIBUTING.md) for more information on how to contribute.

## License

ConfiScan is licensed under the GPLv3 License. See the [`LICENSE`](./LICENSE) file for more details.