mirror of
https://git.madhouse-project.org/algernon/iocaine.git
synced 2025-02-08 18:56:18 +01:00
docs: Sort the sections properly
How? -> Configuration -> Deploying Signed-off-by: Gergely Nagy <me@gergo.csillger.hu>
This commit is contained in:
parent
54952ee58c
commit
e8c9bc0056
4 changed files with 4 additions and 0 deletions
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: iocaine
|
||||
sort_by: weight
|
||||
---
|
||||
|
||||
# Warning
|
||||
|
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
title: Configuration
|
||||
description: Configuring Iocaine
|
||||
weight: 1
|
||||
---
|
||||
|
||||
`iocaine` can be configured via a TOML-format configuration file, or via the environment. Almost everything has sane defaults, but providing a wordlist, and at least one source for the markov generator is **required**.
|
||||
|
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
title: "Deploying"
|
||||
description: How to deploy iocane
|
||||
weight: 2
|
||||
---
|
||||
|
||||
`iocaine` is a single binary, and apart from an optional configuration file, a wordlist, and some sources for its markov generator, there's nothing else it needs. It has no persistent state, no database, and writes nothing to disk. Read more about deploying `iocaine` itself [here](@/deploying/iocaine.md).
|
||||
|
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
title: How?
|
||||
description: How does iocaine work?
|
||||
weight: 0
|
||||
---
|
||||
|
||||
The goal of `iocaine` is to generate a stable, infinite maze of garbage. Each page will be randomly generated, but as long as the configuration (and the training data) remains the same, each individual page will always render the same. Because `iocaine` is expected to work behind a reverse proxy, to shadow the real content when facing unwanted crawlers, it will generate different pages for different hosts, even if the path is the same.
|
Loading…
Reference in a new issue