From e8c9bc0056ef9d778c4dae2fa876ce8c7e3d6704 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 25 Jan 2025 11:44:15 +0100 Subject: [PATCH] docs: Sort the sections properly How? -> Configuration -> Deploying Signed-off-by: Gergely Nagy --- docs/content/_index.md | 1 + docs/content/configuration.md | 1 + docs/content/deploying/index.md | 1 + docs/content/{how-it-works/index.md => how-it-works.md} | 1 + 4 files changed, 4 insertions(+) rename docs/content/{how-it-works/index.md => how-it-works.md} (99%) diff --git a/docs/content/_index.md b/docs/content/_index.md index 006e932..f294552 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -1,5 +1,6 @@ --- title: iocaine +sort_by: weight --- # Warning diff --git a/docs/content/configuration.md b/docs/content/configuration.md index b3eb0e7..23b2f62 100644 --- a/docs/content/configuration.md +++ b/docs/content/configuration.md @@ -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**. diff --git a/docs/content/deploying/index.md b/docs/content/deploying/index.md index fd868e8..24e53b1 100644 --- a/docs/content/deploying/index.md +++ b/docs/content/deploying/index.md @@ -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). diff --git a/docs/content/how-it-works/index.md b/docs/content/how-it-works.md similarity index 99% rename from docs/content/how-it-works/index.md rename to docs/content/how-it-works.md index 78ff23b..a21685a 100644 --- a/docs/content/how-it-works/index.md +++ b/docs/content/how-it-works.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.