https://github.com/axoflow/axosyslog-core-docs
AxoSyslog Core documentation
https://github.com/axoflow/axosyslog-core-docs
axosyslog documentation syslog-ng
Last synced: 9 months ago
JSON representation
AxoSyslog Core documentation
- Host: GitHub
- URL: https://github.com/axoflow/axosyslog-core-docs
- Owner: axoflow
- License: apache-2.0
- Created: 2023-05-25T15:59:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-20T16:09:38.000Z (almost 2 years ago)
- Last Synced: 2024-03-21T16:08:57.953Z (almost 2 years ago)
- Topics: axosyslog, documentation, syslog-ng
- Language: Python
- Homepage: https://axoflow.com/docs/axosyslog-core/
- Size: 5.43 MB
- Stars: 9
- Watchers: 5
- Forks: 5
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# AxoSyslog documentation
Documentation for the AxoSyslog release, originally based on [this version of the syslog-ng Open Source Edition documentation](https://github.com/balabit/syslog-ng-ose-guides/commit/2f4a52ee61d1ea9ad27cb4f3168b95408fddfdf2). We are continuously working on to keep it up-to-date with the latest released version of [AxoSyslog](https://github.com/axoflow/axosyslog/).
## Licensing
See [content/docs/_index.md](content/docs/_index.md).
## Using this repository
The documentation is built using [Hugo](https://gohugo.io/) and the [Docsy theme](https://www.docsy.dev/docs/).
You can run the website locally using Hugo (Extended version).
To use this repository, you need the following installed locally:
- [npm](https://www.npmjs.com/)
- [Go](https://go.dev/)
- [Hugo (Extended version)](https://gohugo.io/), at least version 0.92.3, but not higher than 0.122 (https://github.com/gohugoio/hugo/releases/tag/v0.122.0, see the **Assets** section for binaries)
1. Install the dependencies. Clone the repository and navigate to the directory:
```bash
git clone https://github.com/axoflow/axosyslog-docs/
cd axosyslog-docs
```
1. The documentation site uses the [Docsy Hugo theme](https://github.com/google/docsy#readme). Pull in the submodule:
```shell
git submodule update --init --recursive --depth 1
```
1. Install the dependencies of Docsy:
```shell
cd themes/docsy
npm install
cd ../../
```
1. Run the website locally using Hugo:
```shell
hugo serve
```
This starts the local Hugo server, by default on port 1313 (or another one if this port is already in use). Open `http://localhost:1313` in your browser to view the website. As you make changes to the source files, Hugo automatically updates the website and refreshes the browser.
Common build errors:
- `error: failed to transform resource: TOCSS: failed to transform "scss/main.scss" (text/x-scss): this feature is not available in your current Hugo version`: You have installed the regular version of Hugo, not the extended version.
- `execute of template failed: template: docs/single.html:30:7: executing "docs/single.html" at : error calling partial`: You haven't run `npm install` in the `themes/docsy` directory.