This tool is designed to help manage and update the Homer service configuration file. It automates the process of adding new services to the Homer dashboard.
- Python installed on your system.
- Homer installed on your system: https://github.com/bastienwirtz/homer
- An existing Homer service configuration file (usually in YAML format).
- Basic familiarity with running Python scripts and editing YAML files.
- Ensure Python is installed on your machine.
- Install the
PyYAMLlibrary, necessary for the script. Use the following command:
pip install pyyaml
Before running the script, make sure to update the config_file_path variable in serviceconfig.py to point to your actual Homer configuration file. Replace 'path/to/your/homer/config.yml' with the correct path.
It's advised to back up your existing Homer configuration file before running this script to prevent any accidental loss of data. Create a backup of your configuration file using this command:
cp path/to/your/homer/config.yml path/to/your/homer/config.yml.bkup
- Place
serviceconfig.pyin a convenient location on your computer. - Open a terminal or command prompt.
- Navigate to the directory where
serviceconfig.pyis located. - Run the script using Python:
python3 serviceconfig.py
- Follow the on-screen prompts to input details for the new service.
When running serviceconfig.py, you will be prompted to enter:
- Category Name: The name of the category under which the service will be listed (e.g., 'Apps').
- Category Icon: The icon for the category (leave blank for default 'fas fa-cloud').
- Service Name: The name of the new service.
- URL: The URL for the new service.
- Logo URL or Path: The URL or path to the logo for the new service (leave blank for default logo).
- Tags: Tags for the new service, separated by commas (leave blank if none).
- Keywords: Keywords for the new service, separated by commas (leave blank if none).
The script will update your Homer service configuration file with the provided details.