ezSite

A free and simple static HTML website and sitemap.xml generator written in bash.

Requirements

  • Bash
    • Debian-Based: sudo apt install bash
    • RHEL-Based: sudo yum install bash
  • parse_yaml.sh (included in repo)
  • Pandoc
    • Debian-Based: sudo apt install pandoc
    • RHEL-Based: sudo yum install pandoc
  • ruby
    • Debian-Based: sudo apt install ruby
    • RHEL-Based: sudo yum install ruby

Tested on

  • Amazon Linux 2
  • Debian 9 (old-stable)
  • Debian 10 (stable)
  • Oracle Linux Linux 8
  • Red Hat Enterprise Linux Linux 8
  • Ubuntu LTS (18.04)
  • Ubuntu LTS (20.04)
  • Oracle Solaris 11.4
  • NetBSD 8.1

Setup

  • Download ezsite.zip and extract zip
  • Switch to directory cd ezsite
  • Copy header.sh.sample to header.sh and footer.sh.sample to footer.sh, and modify at will
  • Set the correct domain name in sitemap.sh
  • Set the correct website paths in run.sh
  • Create output directory mkdir output
  • Run ./run.sh

Contributions

The upstream URL of this project is https://github.com/AntonMcClure/ezsite. Contributions in any form can be sent to git+ezsite@antonmcclure.com. For sending patches by email, see https://git-send-email.io/.

DO NOT DISCLOSE UNPATCHED SECURITY RISKS PUBLICLY.

License

Copyright (c) 2019-2021 Anton McClure anton@antonmcclure.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions.

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Information

Type:
Service (Software as a Service)
Category:
Utility
Vendor:
Anton McClure
Version:
3.0.0
Release Date:
January 15, 2021
First Release:
July 5, 2020
Support:
None (as-is, without warranty)
License:
MIT License
User Interface:
Command Line
Platform:
Solaris, FreeBSD, OpenBSD, NetBSD, macOS, Linux