Compare commits
No commits in common. "main" and "flake-update-2024-04-08" have entirely different histories.
main
...
flake-upda
1
.gitignore
vendored
1
.gitignore
vendored
@ -1,5 +1,4 @@
|
||||
/public
|
||||
.vscode
|
||||
.direnv
|
||||
result*
|
||||
.pre-commit-config.yaml
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
Copyright 2023 Clan contributers
|
||||
Copyright 2023 cLAN contributers
|
||||
|
||||
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:
|
||||
|
||||
|
||||
23
README.md
23
README.md
@ -1,13 +1,27 @@
|
||||
# Getting start with the repo
|
||||
|
||||
This is the source for the Clan homepage.
|
||||
This is the source for the homepage.
|
||||
We use [zola](https://www.getzola.org/) for building a static website.
|
||||
|
||||
## Build the homepage
|
||||
|
||||
This will build the website including pages defined in the clan-core repo under `/docs`:
|
||||
|
||||
```command
|
||||
$ nix build
|
||||
```
|
||||
|
||||
## Start a local webserver
|
||||
|
||||
This server will include all the pages from clan-core, but doesn't automatically refresh. Also make sure to wipe your browsers cache after each change.
|
||||
|
||||
```command
|
||||
$ nix run .#serve
|
||||
```
|
||||
|
||||
## zola build & serve
|
||||
Alternatively `zola build` and `zola serve` can be used for development but the result will be missing the pages defined in the clan-core repo.
|
||||
|
||||
## Contributing
|
||||
|
||||
Send changes to https://git.clan.lol/clan/clan-homepage
|
||||
@ -17,3 +31,10 @@ Send changes to https://git.clan.lol/clan/clan-homepage
|
||||
```
|
||||
$ nix run .#deploy
|
||||
```
|
||||
|
||||
|
||||
## Create a new post
|
||||
|
||||
```
|
||||
$ nix run .#new-post "September Changelog"
|
||||
```
|
||||
|
||||
29
config.toml
29
config.toml
@ -1,6 +1,6 @@
|
||||
# The URL the site will be built for
|
||||
base_url = "https://clan.lol"
|
||||
title = "Clan"
|
||||
title = "cLAN"
|
||||
|
||||
# The site theme to use.
|
||||
theme = "adidoks"
|
||||
@ -26,7 +26,7 @@ taxonomies = [
|
||||
# Whether to build a search index to be used later on by a JavaScript library
|
||||
# When set to "true", a search index is built from the pages and section
|
||||
# content for `default_language`.
|
||||
build_search_index = false
|
||||
build_search_index = true
|
||||
|
||||
[search]
|
||||
# Whether to include the title of the page/section in the index
|
||||
@ -44,7 +44,7 @@ highlight_code = true
|
||||
|
||||
[extra]
|
||||
# Put all your custom variables here
|
||||
author = "Clan contributors"
|
||||
author = "cLAN contributors"
|
||||
email = "admin@clan.lol"
|
||||
|
||||
# If running on netlify.app site, set to true
|
||||
@ -58,7 +58,7 @@ theme_color = "#fff"
|
||||
|
||||
# More about site's title
|
||||
title_separator = "-" # set as |, -, _, etc
|
||||
title_addition = "Build your own Clan"
|
||||
title_addition = "Build your own cLAN"
|
||||
|
||||
|
||||
# Set date format in blog publish metadata
|
||||
@ -103,11 +103,30 @@ url = "https://git.clan.lol/clan/clan-core"
|
||||
post = "v0.1.0"
|
||||
weight = 20
|
||||
|
||||
|
||||
# Menu items
|
||||
[[extra.menu.main]]
|
||||
name = "Docs"
|
||||
section = "docs"
|
||||
url = "/docs/getting-started/introduction/"
|
||||
weight = 10
|
||||
|
||||
[[extra.menu.main]]
|
||||
name = "Blog"
|
||||
section = "blog"
|
||||
url = "/blog/"
|
||||
weight = 20
|
||||
|
||||
# Footer contents
|
||||
[extra.footer]
|
||||
info = 'Powered by <a href="https://www.getzola.org/">Zola</a>, and <a href="https://github.com/aaranxu/adidoks">AdiDoks</a>'
|
||||
|
||||
[[extra.footer.nav]]
|
||||
name = "Privacy Policy"
|
||||
name = "Privacy"
|
||||
url = "/privacy-policy/"
|
||||
weight = 10
|
||||
|
||||
[[extra.footer.nav]]
|
||||
name = "The Vision"
|
||||
url = "/docs/thevision"
|
||||
weight = 20
|
||||
|
||||
39
content/_index.md
Normal file
39
content/_index.md
Normal file
@ -0,0 +1,39 @@
|
||||
+++
|
||||
title = "Build your own"
|
||||
|
||||
# The homepage contents
|
||||
[extra]
|
||||
lead = '<img src="/logo/clan-dark.png" class="clogo" width="100px" height="100px" alt="cLAN logo"></img> <br><b>cLAN</b> envisions a new model for a decentralized network, designed to provide families, smaller groups, and small businesses a platform that’s private, secure, and user-friendly. '
|
||||
url = "/docs/thevision/"
|
||||
url_button = "Learn more"
|
||||
repo_version = "cLAN v0.0.0-alpha"
|
||||
repo_license = "Open-source MIT License."
|
||||
repo_url = "https://git.clan.lol/clan/"
|
||||
|
||||
# Menu items
|
||||
[[extra.menu.main]]
|
||||
name = "Docs"
|
||||
section = "docs"
|
||||
url = "/docs/thevision"
|
||||
weight = 10
|
||||
|
||||
[[extra.menu.main]]
|
||||
name = "Blog"
|
||||
section = "blog"
|
||||
url = "/blog/"
|
||||
weight = 20
|
||||
|
||||
|
||||
|
||||
[[extra.list]]
|
||||
title = "Easy to use"
|
||||
content = 'cLAN provides a user-friendly interface that allows you to establish your own private network, complete with services.'
|
||||
|
||||
[[extra.list]]
|
||||
title = "Open-source"
|
||||
content = 'All code for cLAN is freely available and open-source.'
|
||||
|
||||
[[extra.list]]
|
||||
title = "Decentralized"
|
||||
content = "The design of cLAN enables the distribution of your applications/services across several machines. This increases the resilience of the network, ensuring continued operation even if some computers become unavailable."
|
||||
+++
|
||||
11
content/authors/Mic92.md
Normal file
11
content/authors/Mic92.md
Normal file
@ -0,0 +1,11 @@
|
||||
+++
|
||||
title = "Mic92"
|
||||
description = "Contributor to cLAN."
|
||||
date = 2021-04-01T08:50:45+00:00
|
||||
updated = 2021-04-01T08:50:45+00:00
|
||||
draft = false
|
||||
+++
|
||||
|
||||
Contributor to **clan**.
|
||||
|
||||
[@thalheim](https://thalheim.io)
|
||||
7
content/authors/Qubasa.md
Normal file
7
content/authors/Qubasa.md
Normal file
@ -0,0 +1,7 @@
|
||||
+++
|
||||
title = "Qubasa"
|
||||
description = "Contributor to cLAN."
|
||||
+++
|
||||
|
||||
Contributor to **clan**.
|
||||
[@Luis-Hebendanz](https://github.com/Luis-Hebendanz)
|
||||
6
content/authors/W.md
Normal file
6
content/authors/W.md
Normal file
@ -0,0 +1,6 @@
|
||||
+++
|
||||
title = "W"
|
||||
description = "Founder of Clan"
|
||||
+++
|
||||
|
||||
Project founder and visionary of **clan**.
|
||||
20
content/authors/_index.md
Normal file
20
content/authors/_index.md
Normal file
@ -0,0 +1,20 @@
|
||||
+++
|
||||
title = "Authors"
|
||||
description = "The authors of the blog articles."
|
||||
date = 2021-04-01T08:00:00+00:00
|
||||
updated = 2024-03-01T08:00:00+00:00
|
||||
draft = false
|
||||
|
||||
# If add a new author page in this section, please add a new item,
|
||||
# and the format is as follows:
|
||||
#
|
||||
# "author-name-in-url" = "the-full-path-of-the-author-page"
|
||||
#
|
||||
# Note: We use quoted keys here.
|
||||
[extra.author_pages]
|
||||
"Mic92" = "authors/Mic92.md"
|
||||
"Qubasa" = "authors/Qubasa.md"
|
||||
"W" = "authors/W.md"
|
||||
+++
|
||||
|
||||
The authors of the blog articles.
|
||||
72
content/blog/2024-03-19-hello-world.md
Normal file
72
content/blog/2024-03-19-hello-world.md
Normal file
@ -0,0 +1,72 @@
|
||||
+++
|
||||
title = "Introducing Clan: Full-Stack Computing Redefined"
|
||||
description = "Introducing cLAN, a new model for a decentralized network, designed to provide families, smaller groups, and small businesses a platform that’s private, secure, and user-friendly."
|
||||
date = 2024-03-19T09:19:42+00:00
|
||||
updated = 2024-03-19T09:19:42+00:00
|
||||
draft = false
|
||||
template = "blog/page.html"
|
||||
|
||||
[taxonomies]
|
||||
authors = ["W", "Qubasa"]
|
||||
|
||||
+++
|
||||
|
||||
In a digital age where users are guided increasingly toward submission and dependence, Clan reclaims computing and networking from the ground up.
|
||||
|
||||
Clan enables users to build any system from a git repository, automate secret handling, and join devices in a secure darknet. This control extends beyond applications to communication protocols and the operating system itself, putting you fully in charge of your own digital environment.
|
||||
|
||||
## Why We're Building Clan
|
||||
|
||||
Our mission is simple: to restore fun, freedom, and functionality to computing as an open source project. We believe in building tools that empower users, foster innovation, and challenge the limitations imposed by outdated paradigms. Clan, in its essence, is an open source endeavor; it's our contribution to a future where technology serves humanity, not the other way around.
|
||||
|
||||
## How Clan Changes the Game
|
||||
Clan embodies a new philosophy in system, application, and network design. It enables seamless, secure communication across devices, simplifies software distribution and updates, and offers both public and private network configurations. Here are some of the ways it accomplishes this:
|
||||
|
||||
- **Nix as a Foundation:** Imagine a safety net for your computer's operating system, one that lets you make changes or updates without the fear of causing a crash or losing data. Nix simplifies the complexities of system design, ensuring that updates are safe and systems are more reliable.
|
||||
|
||||
- **Simplified System Deployment:** Building and managing a computer system, from the operating system to the software you use, often feels like putting together a complex puzzle. With Clan, the puzzle pieces are replaced by a set of building blocks. Leveraging the power of Nix and Clan's innovative toolkit, anyone from tech-savvy administrators to everyday users can create and maintain what we call "full-stack systems" (everything your computer needs to run smoothly).
|
||||
|
||||
- **A Leap in Connectivity:** Imagine if you could create private, secure pathways between your devices, bypassing the noisy and often insecure internet. Clan makes this possible through something called "overlay networks." These networks are like private tunnels, allowing your devices to talk to each other securely and directly. With Clan's built-in overlay networks and automatically configured services, connecting your devices becomes seamless, secure, and hassle-free.
|
||||
|
||||
- **Security Through Separation:** Clan employs sandboxing and virtual machines, a technology that runs code in isolated environments - so even if you explore new Clans, your system remains protected from potential threats.
|
||||
|
||||
- **Reliable:** With Clan, your data and services are preserved for the long haul. We focus on self-hosted backups and integration with the [Fediverse](https://de.wikipedia.org/wiki/Fediverse), a network of interconnected, independent online communities, so your digital life remains uninterrupted and under your control.
|
||||
|
||||
|
||||
## A Glimpse at Clan's Features
|
||||
|
||||
- **Social Scaling:** Choose between creating a private sanctuary for your closest contacts, a dynamic space for a self-contained community, or embracing the open web with public Clans anyone can join.
|
||||
|
||||
{{ video(name="show_join.webm")}}
|
||||
|
||||
- **Seamless VM Integration:** Applications running in virtual machines can appear and behave as if they're part of your main operating system — a blend of power and simplicity.
|
||||
|
||||
{{ video(name="show_run.webm")}}
|
||||
|
||||
- **Robust Backup Management:** Keep your data safe _forever_ - never worry about cloud services disappearing in 10 years.
|
||||
|
||||
|
||||
- **Intuitive Secret Management:** Clan simplifies digital security by automating the creation and management of encryption keys and passwords for your services.
|
||||
{{ asciinema(name="secrets.cast") }}
|
||||
|
||||
- **Remote Install:** Set up and manage Clan systems anywhere in the world with just a QR scan or SSH access, making remote installations as easy as snapping a photo or sharing a link.
|
||||
{{ asciinema(name="nixos-install.cast") }}
|
||||
|
||||
|
||||
## Who Stands to Benefit?
|
||||
|
||||
Clan is for anyone and everyone who believes in the power of open source technology to connect, empower, and protect. From system administrators to less tech-savvy individuals, small business owners to privacy-conscious users, Clan offers something for everyone — a way to reclaim control and redefine how we interact with technology.
|
||||
|
||||
## Join the Revolution
|
||||
|
||||
Ready to control your digital world? Clan is more than a tool—it's a movement. Secure your data, manage your systems easily, or connect with others how you like. Start with Clan for a better digital future.
|
||||
|
||||
Connect with us on our [Matrix channel at clan.lol](https://matrix.to/#/!djzOHBBBHnwQkgNgdV:matrix.org?via=blog.clan.lol) or through our IRC bridges (coming soon).
|
||||
|
||||
Want to see the code? Check it out [on our Gitea](https://git.clan.lol/clan/clan-core) or [on GitHub](https://github.com/clan-lol/clan-core).
|
||||
|
||||
Or follow our RSS feed by clicking in the top right corner!
|
||||
|
||||
Join us and be part of changing technology for the better, together.
|
||||
|
||||
|
||||
7
content/blog/_index.md
Normal file
7
content/blog/_index.md
Normal file
@ -0,0 +1,7 @@
|
||||
+++
|
||||
title = "Blog"
|
||||
description = "Blog"
|
||||
sort_by = "date"
|
||||
paginate_by = 2
|
||||
template = "blog/section.html"
|
||||
+++
|
||||
9
content/docs/_index.md
Normal file
9
content/docs/_index.md
Normal file
@ -0,0 +1,9 @@
|
||||
+++
|
||||
title = "Docs"
|
||||
description = "The documents of the AdiDoks theme."
|
||||
date = 2025-05-01T08:00:00+00:00
|
||||
updated = 2021-05-01T08:00:00+00:00
|
||||
sort_by = "weight"
|
||||
weight = 1
|
||||
template = "docs/section.html"
|
||||
+++
|
||||
10
content/docs/contributing/_index.md
Normal file
10
content/docs/contributing/_index.md
Normal file
@ -0,0 +1,10 @@
|
||||
+++
|
||||
title = "Contributing"
|
||||
description = "Find out how to contribute to cLAN."
|
||||
date = 2025-05-01T18:00:00+00:00
|
||||
updated = 2021-05-01T18:00:00+00:00
|
||||
template = "docs/section.html"
|
||||
sort_by = "weight"
|
||||
weight = 4
|
||||
draft = false
|
||||
+++
|
||||
28
content/docs/contributing/how-to-contribute.md
Normal file
28
content/docs/contributing/how-to-contribute.md
Normal file
@ -0,0 +1,28 @@
|
||||
+++
|
||||
title = "How to Contribute"
|
||||
description = "Contribute to cLAN, improve documentation, or submit to showcase."
|
||||
date = 2021-05-01T18:10:00+00:00
|
||||
updated = 2021-05-01T18:10:00+00:00
|
||||
draft = false
|
||||
weight = 410
|
||||
sort_by = "weight"
|
||||
template = "docs/page.html"
|
||||
|
||||
[extra]
|
||||
lead = "Contribute to cLAN, improve documentation, or submit to showcase."
|
||||
toc = true
|
||||
top = false
|
||||
+++
|
||||
|
||||
## Contribute
|
||||
|
||||
👉 Explore our repos at [git.clan.lol](https://git.clan.lol/explore/repos)
|
||||
|
||||
👉 [Browse issues](https://git.clan.lol/issues)
|
||||
|
||||
👉 [Create new issue](https://git.clan.lol/clan/clan-core/issues/new)
|
||||
|
||||
|
||||
## Improve these docs
|
||||
|
||||
👉 The documentation lives in [git.clan.lol/clan/clan-homepage](https://git.clan.lol/clan/clan-homepage/src/branch/main/content/docs)
|
||||
10
content/docs/help/_index.md
Normal file
10
content/docs/help/_index.md
Normal file
@ -0,0 +1,10 @@
|
||||
+++
|
||||
title = "Help"
|
||||
description = "Get help on AdiDoks."
|
||||
date = 2025-05-01T19:00:00+00:00
|
||||
updated = 2021-05-01T19:00:00+00:00
|
||||
template = "docs/section.html"
|
||||
sort_by = "weight"
|
||||
weight = 5
|
||||
draft = false
|
||||
+++
|
||||
32
content/docs/help/faq.md
Normal file
32
content/docs/help/faq.md
Normal file
@ -0,0 +1,32 @@
|
||||
+++
|
||||
title = "FAQ"
|
||||
description = "Answers to frequently asked questions."
|
||||
date = 2021-05-01T19:30:00+00:00
|
||||
updated = 2021-05-01T19:30:00+00:00
|
||||
draft = false
|
||||
weight = 30
|
||||
sort_by = "weight"
|
||||
template = "docs/page.html"
|
||||
|
||||
[extra]
|
||||
lead = "Answers to frequently asked questions."
|
||||
toc = true
|
||||
top = false
|
||||
+++
|
||||
|
||||
## Keyboard shortcuts for search?
|
||||
|
||||
- focus: `/`
|
||||
- select: `↓` and `↑`
|
||||
- open: `Enter`
|
||||
- close: `Esc`
|
||||
|
||||
## Other documentation?
|
||||
|
||||
- [https://nixos.org](https://nixos.org/)
|
||||
|
||||
## Contact the creator?
|
||||
|
||||
Send an E-mail:
|
||||
|
||||
- <admins@clan.lol>
|
||||
122
content/docs/overview/design-overview.drawio
Normal file
122
content/docs/overview/design-overview.drawio
Normal file
@ -0,0 +1,122 @@
|
||||
<mxfile host="app.diagrams.net" modified="2024-01-04T14:37:14.987Z" agent="Mozilla/5.0 (X11; Linux x86_64; rv:107.0) Gecko/20100101 Firefox/107.0" etag="hDO36PXgKwa7GlXmf0pK" version="21.5.0" type="device">
|
||||
<diagram name="Page-1" id="Page-1">
|
||||
<mxGraphModel dx="3034" dy="1872" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
|
||||
<root>
|
||||
<mxCell id="0" />
|
||||
<mxCell id="1" value="Connector" parent="0" />
|
||||
<mxCell id="L0__EUAIFv-v6VTxFZ8R-24" value="" style="verticalLabelPosition=bottom;html=1;verticalAlign=top;align=center;strokeColor=none;fillColor=#00BEF2;shape=mxgraph.azure.laptop;pointerEvents=1;" vertex="1" parent="1">
|
||||
<mxGeometry x="250" y="280" width="290" height="240" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="r0mgfz6IdKgSaTeHQ_le-60" value="<div><font style="font-size: 24px;">Different <br></font></div><div><font style="font-size: 24px;">VPN Mesh network</font></div>" style="ellipse;shape=cloud;whiteSpace=wrap;html=1;" parent="1" vertex="1">
|
||||
<mxGeometry x="890" y="950.0000000000001" width="320" height="240" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="r0mgfz6IdKgSaTeHQ_le-33" value="<div><font style="font-size: 24px;">VPN Mesh network</font></div>" style="ellipse;shape=cloud;whiteSpace=wrap;html=1;" parent="1" vertex="1">
|
||||
<mxGeometry x="430" y="560" width="320" height="240" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="r0mgfz6IdKgSaTeHQ_le-67" value="" style="endArrow=classic;html=1;rounded=0;strokeWidth=3;startArrow=classic;startFill=1;entryX=0.25;entryY=0.25;entryDx=0;entryDy=0;entryPerimeter=0;" parent="1" target="r0mgfz6IdKgSaTeHQ_le-33" edge="1">
|
||||
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
||||
<mxPoint x="380" y="530" as="sourcePoint" />
|
||||
<mxPoint x="590" y="645" as="targetPoint" />
|
||||
</mxGeometry>
|
||||
</mxCell>
|
||||
<mxCell id="22" value="<font data-darkreader-inline-color="" style="font-size: 28px; font-family: &quot;calibri&quot;; color: rgb(0, 0, 0); direction: ltr; letter-spacing: 0px; line-height: 120%; opacity: 1; --darkreader-inline-color: #e8e6e3;">Computer connected through VM<br></font>" style="verticalAlign=middle;align=center;vsdxID=28;fillColor=none;gradientColor=none;shape=stencil(nZBLDoAgDERP0z3SIyjew0SURgSD+Lu9kMZoXLhwN9O+tukAlrNpJg1SzDH4QW/URgNYgZTkjA4UkwJUgGXng+6DX1zLfmoymdXo17xh5zmRJ6Q42BWCfc2oJfdAr+Yv+AP9Cb7OJ3H/2JG1HNGz/84klThPVCc=);strokeColor=none;labelBackgroundColor=none;rounded=0;html=1;whiteSpace=wrap;" parent="1" vertex="1">
|
||||
<mxGeometry x="857.5" y="400" width="265" height="130" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="r0mgfz6IdKgSaTeHQ_le-66" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.875;entryY=0.5;entryDx=0;entryDy=0;entryPerimeter=0;strokeWidth=3;startArrow=classic;startFill=1;" parent="1" target="r0mgfz6IdKgSaTeHQ_le-33" edge="1">
|
||||
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
||||
<mxPoint x="860" y="628.7096774193546" as="sourcePoint" />
|
||||
<mxPoint x="566" y="717" as="targetPoint" />
|
||||
</mxGeometry>
|
||||
</mxCell>
|
||||
<mxCell id="ZT00lVDF8hyaAqTCrx0f-22" value="NixOS" style="vsdxID=12;fillColor=#0050ef;shape=stencil(nZBLDoAgDERP0z3SIyjew0SURgSD+Lu9kMZoXLhwN9O+tukAlrNpJg1SzDH4QW/URgNYgZTkjA4UkwJUgGXng+6DX1zLfmoymdXo17xh5zmRJ6Q42BWCfc2oJfdAr+Yv+AP9Cb7OJ3H/2JG1HNGz/84klThPVCc=);strokeColor=#001DBC;strokeWidth=3;labelBackgroundColor=none;rounded=0;html=1;whiteSpace=wrap;fontColor=#ffffff;fontSize=28;" parent="1" vertex="1">
|
||||
<mxGeometry x="300" y="400" width="200" height="36.25" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="eZtIASL5zvcn_9goES__-32" value="<font data-darkreader-inline-color="" style="font-size: 28px; font-family: &quot;calibri&quot;; color: rgb(0, 0, 0); direction: ltr; letter-spacing: 0px; line-height: 120%; opacity: 1; --darkreader-inline-color: #e8e6e3;">Computer directly connected<br></font>" style="verticalAlign=middle;align=left;vsdxID=28;fillColor=none;gradientColor=none;shape=stencil(nZBLDoAgDERP0z3SIyjew0SURgSD+Lu9kMZoXLhwN9O+tukAlrNpJg1SzDH4QW/URgNYgZTkjA4UkwJUgGXng+6DX1zLfmoymdXo17xh5zmRJ6Q42BWCfc2oJfdAr+Yv+AP9Cb7OJ3H/2JG1HNGz/84klThPVCc=);strokeColor=none;labelBackgroundColor=none;rounded=0;html=1;whiteSpace=wrap;" parent="1" vertex="1">
|
||||
<mxGeometry x="522.5" y="319.9950996015936" width="135" height="102.54980079681275" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="ZT00lVDF8hyaAqTCrx0f-23" value="" style="group" parent="1" vertex="1" connectable="0">
|
||||
<mxGeometry x="300" y="320" width="200" height="60" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="eZtIASL5zvcn_9goES__-42" style="vsdxID=12;fillColor=#0050ef;shape=stencil(nZBLDoAgDERP0z3SIyjew0SURgSD+Lu9kMZoXLhwN9O+tukAlrNpJg1SzDH4QW/URgNYgZTkjA4UkwJUgGXng+6DX1zLfmoymdXo17xh5zmRJ6Q42BWCfc2oJfdAr+Yv+AP9Cb7OJ3H/2JG1HNGz/84klThPVCc=);strokeColor=#001DBC;strokeWidth=3;labelBackgroundColor=none;rounded=0;html=1;whiteSpace=wrap;fontColor=#ffffff;" parent="ZT00lVDF8hyaAqTCrx0f-23" vertex="1">
|
||||
<mxGeometry width="200" height="60" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="eZtIASL5zvcn_9goES__-43" value="<font data-darkreader-inline-color="" style="font-size: 28px; font-family: &quot;calibri&quot;; color: rgb(255, 255, 255); direction: ltr; letter-spacing: 0px; line-height: 120%; opacity: 1; --darkreader-inline-color: #e8e6e3;">Mumble Client<br></font>" style="verticalAlign=middle;align=center;vsdxID=25;fillColor=none;shape=stencil(nZBLDoAgDERP0z3SIyjew0SURgSD+Lu9kMZoXLhwN9O+tukAlrNpJg1SzDH4QW/URgNYgZTkjA4UkwJUgGXng+6DX1zLfmoymdXo17xh5zmRJ6Q42BWCfc2oJfdAr+Yv+AP9Cb7OJ3H/2JG1HNGz/84klThPVCc=);strokeColor=none;labelBackgroundColor=none;rounded=0;html=1;whiteSpace=wrap;" parent="ZT00lVDF8hyaAqTCrx0f-23" vertex="1">
|
||||
<mxGeometry x="9.807692307692303" y="13.714285714285712" width="180.3846153846154" height="31.71428571428571" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="L0__EUAIFv-v6VTxFZ8R-32" value="" style="group" vertex="1" connectable="0" parent="1">
|
||||
<mxGeometry x="840" y="520" width="300" height="250" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="L0__EUAIFv-v6VTxFZ8R-25" value="" style="verticalLabelPosition=bottom;html=1;verticalAlign=top;align=center;strokeColor=none;fillColor=#00BEF2;shape=mxgraph.azure.laptop;pointerEvents=1;" vertex="1" parent="L0__EUAIFv-v6VTxFZ8R-32">
|
||||
<mxGeometry width="300" height="250" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="L0__EUAIFv-v6VTxFZ8R-30" value="<font style="font-size: 20px;">VM with NixOS </font>" style="swimlane;whiteSpace=wrap;html=1;" vertex="1" parent="L0__EUAIFv-v6VTxFZ8R-32">
|
||||
<mxGeometry x="45" y="20" width="200" height="150" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="L0__EUAIFv-v6VTxFZ8R-31" value="" style="group" vertex="1" connectable="0" parent="L0__EUAIFv-v6VTxFZ8R-30">
|
||||
<mxGeometry x="10" y="40" width="180" height="90" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="eZtIASL5zvcn_9goES__-39" style="vsdxID=12;fillColor=#0050ef;shape=stencil(nZBLDoAgDERP0z3SIyjew0SURgSD+Lu9kMZoXLhwN9O+tukAlrNpJg1SzDH4QW/URgNYgZTkjA4UkwJUgGXng+6DX1zLfmoymdXo17xh5zmRJ6Q42BWCfc2oJfdAr+Yv+AP9Cb7OJ3H/2JG1HNGz/84klThPVCc=);strokeColor=#001DBC;strokeWidth=3;labelBackgroundColor=none;rounded=0;html=1;whiteSpace=wrap;fontColor=#ffffff;" parent="L0__EUAIFv-v6VTxFZ8R-31" vertex="1">
|
||||
<mxGeometry width="180" height="90" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="eZtIASL5zvcn_9goES__-40" value="<font data-darkreader-inline-color="" style="font-size: 28px; font-family: &quot;calibri&quot;; color: rgb(255, 255, 255); direction: ltr; letter-spacing: 0px; line-height: 120%; opacity: 1; --darkreader-inline-color: #e8e6e3;">Mumble Client<br></font>" style="verticalAlign=middle;align=center;vsdxID=25;fillColor=none;shape=stencil(nZBLDoAgDERP0z3SIyjew0SURgSD+Lu9kMZoXLhwN9O+tukAlrNpJg1SzDH4QW/URgNYgZTkjA4UkwJUgGXng+6DX1zLfmoymdXo17xh5zmRJ6Q42BWCfc2oJfdAr+Yv+AP9Cb7OJ3H/2JG1HNGz/84klThPVCc=);strokeColor=none;labelBackgroundColor=none;rounded=0;html=1;whiteSpace=wrap;" parent="L0__EUAIFv-v6VTxFZ8R-31" vertex="1">
|
||||
<mxGeometry x="8.826923076923094" y="27.64285714285714" width="162.34615384615387" height="47.57142857142858" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="ZT00lVDF8hyaAqTCrx0f-24" value="<div>Linux or MacOS</div>" style="vsdxID=12;fillColor=#0050ef;shape=stencil(nZBLDoAgDERP0z3SIyjew0SURgSD+Lu9kMZoXLhwN9O+tukAlrNpJg1SzDH4QW/URgNYgZTkjA4UkwJUgGXng+6DX1zLfmoymdXo17xh5zmRJ6Q42BWCfc2oJfdAr+Yv+AP9Cb7OJ3H/2JG1HNGz/84klThPVCc=);strokeColor=#001DBC;strokeWidth=3;labelBackgroundColor=none;rounded=0;html=1;whiteSpace=wrap;fontColor=#ffffff;fontSize=28;" parent="L0__EUAIFv-v6VTxFZ8R-32" vertex="1">
|
||||
<mxGeometry x="30" y="205" width="240" height="35" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="L0__EUAIFv-v6VTxFZ8R-45" value="" style="image;points=[];aspect=fixed;html=1;align=center;shadow=0;dashed=0;image=img/lib/allied_telesis/computer_and_terminals/Personal_Computer_with_Server.svg;imageBackground=#FFFFFF;fillStyle=solid;" vertex="1" parent="1">
|
||||
<mxGeometry x="340" y="810" width="457.6" height="457.6" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="L0__EUAIFv-v6VTxFZ8R-40" value="<font style="font-size: 20px;">VM with NixOS </font>" style="swimlane;whiteSpace=wrap;html=1;startSize=23;fillColor=#FFFFFF;gradientColor=none;" vertex="1" parent="1">
|
||||
<mxGeometry x="440" y="1070" width="282.25" height="160" as="geometry">
|
||||
<mxRectangle x="1180" y="730" width="180" height="40" as="alternateBounds" />
|
||||
</mxGeometry>
|
||||
</mxCell>
|
||||
<mxCell id="L0__EUAIFv-v6VTxFZ8R-50" value="" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="L0__EUAIFv-v6VTxFZ8R-40">
|
||||
<mxGeometry y="30" width="282.25" height="130" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="L0__EUAIFv-v6VTxFZ8R-41" value="" style="group;align=left;" vertex="1" connectable="0" parent="L0__EUAIFv-v6VTxFZ8R-40">
|
||||
<mxGeometry x="52.25" y="50" width="180" height="90" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="L0__EUAIFv-v6VTxFZ8R-42" style="vsdxID=12;fillColor=#0050ef;shape=stencil(nZBLDoAgDERP0z3SIyjew0SURgSD+Lu9kMZoXLhwN9O+tukAlrNpJg1SzDH4QW/URgNYgZTkjA4UkwJUgGXng+6DX1zLfmoymdXo17xh5zmRJ6Q42BWCfc2oJfdAr+Yv+AP9Cb7OJ3H/2JG1HNGz/84klThPVCc=);strokeColor=#001DBC;strokeWidth=3;labelBackgroundColor=none;rounded=0;html=1;whiteSpace=wrap;fontColor=#ffffff;" vertex="1" parent="L0__EUAIFv-v6VTxFZ8R-41">
|
||||
<mxGeometry width="180" height="90" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="L0__EUAIFv-v6VTxFZ8R-43" value="<font data-darkreader-inline-color="" style="font-size: 28px; font-family: &quot;calibri&quot;; color: rgb(255, 255, 255); direction: ltr; letter-spacing: 0px; line-height: 120%; opacity: 1; --darkreader-inline-color: #e8e6e3;">Nextcloud</font><font data-darkreader-inline-color="" style="font-size: 28px; font-family: &quot;calibri&quot;; color: rgb(255, 255, 255); direction: ltr; letter-spacing: 0px; line-height: 120%; opacity: 1; --darkreader-inline-color: #e8e6e3;"></font>" style="verticalAlign=middle;align=center;vsdxID=25;fillColor=none;shape=stencil(nZBLDoAgDERP0z3SIyjew0SURgSD+Lu9kMZoXLhwN9O+tukAlrNpJg1SzDH4QW/URgNYgZTkjA4UkwJUgGXng+6DX1zLfmoymdXo17xh5zmRJ6Q42BWCfc2oJfdAr+Yv+AP9Cb7OJ3H/2JG1HNGz/84klThPVCc=);strokeColor=none;labelBackgroundColor=none;rounded=0;html=1;whiteSpace=wrap;" vertex="1" parent="L0__EUAIFv-v6VTxFZ8R-41">
|
||||
<mxGeometry x="8.826923076923094" y="27.64285714285714" width="162.34615384615387" height="47.57142857142858" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="r0mgfz6IdKgSaTeHQ_le-63" value="" style="endArrow=classic;html=1;rounded=0;strokeWidth=3;startArrow=classic;startFill=1;entryX=0.16;entryY=0.55;entryDx=0;entryDy=0;entryPerimeter=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="L0__EUAIFv-v6VTxFZ8R-50" target="r0mgfz6IdKgSaTeHQ_le-60" edge="1">
|
||||
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
||||
<mxPoint x="1658.8" y="1118" as="sourcePoint" />
|
||||
<mxPoint x="1149.9999999999998" y="1229.9999999999995" as="targetPoint" />
|
||||
</mxGeometry>
|
||||
</mxCell>
|
||||
<mxCell id="r0mgfz6IdKgSaTeHQ_le-65" value="" style="endArrow=classic;html=1;rounded=0;strokeWidth=3;startArrow=classic;startFill=1;entryX=0.55;entryY=0.95;entryDx=0;entryDy=0;entryPerimeter=0;exitX=0.5;exitY=0;exitDx=0;exitDy=0;" parent="1" source="L0__EUAIFv-v6VTxFZ8R-51" target="r0mgfz6IdKgSaTeHQ_le-33" edge="1">
|
||||
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
||||
<mxPoint x="566.125" y="880" as="sourcePoint" />
|
||||
<mxPoint x="660" y="840" as="targetPoint" />
|
||||
</mxGeometry>
|
||||
</mxCell>
|
||||
<mxCell id="L0__EUAIFv-v6VTxFZ8R-46" value="<div><font data-darkreader-inline-color="" style="font-size: 28px; font-family: &quot;calibri&quot;; color: rgb(0, 0, 0); direction: ltr; letter-spacing: 0px; line-height: 120%; opacity: 1; --darkreader-inline-color: #e8e6e3;">Computer joined multiple cLANs</font></div><div><font data-darkreader-inline-color="" style="font-size: 28px; font-family: &quot;calibri&quot;; color: rgb(0, 0, 0); direction: ltr; letter-spacing: 0px; line-height: 120%; opacity: 1; --darkreader-inline-color: #e8e6e3;">&nbsp;through VMs</font></div>" style="verticalAlign=middle;align=right;vsdxID=28;fillColor=none;gradientColor=none;shape=stencil(nZBLDoAgDERP0z3SIyjew0SURgSD+Lu9kMZoXLhwN9O+tukAlrNpJg1SzDH4QW/URgNYgZTkjA4UkwJUgGXng+6DX1zLfmoymdXo17xh5zmRJ6Q42BWCfc2oJfdAr+Yv+AP9Cb7OJ3H/2JG1HNGz/84klThPVCc=);strokeColor=none;labelBackgroundColor=none;rounded=0;html=1;whiteSpace=wrap;" vertex="1" parent="1">
|
||||
<mxGeometry x="70" y="940" width="265" height="130" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="L0__EUAIFv-v6VTxFZ8R-51" value="<font style="font-size: 20px;">VM with NixOS </font>" style="swimlane;whiteSpace=wrap;html=1;startSize=23;fillColor=#FFFFFF;gradientColor=none;" vertex="1" parent="1">
|
||||
<mxGeometry x="420" y="880" width="282.25" height="160" as="geometry">
|
||||
<mxRectangle x="1180" y="730" width="180" height="40" as="alternateBounds" />
|
||||
</mxGeometry>
|
||||
</mxCell>
|
||||
<mxCell id="L0__EUAIFv-v6VTxFZ8R-52" value="" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="L0__EUAIFv-v6VTxFZ8R-51">
|
||||
<mxGeometry y="30" width="282.25" height="130" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="L0__EUAIFv-v6VTxFZ8R-53" value="" style="group;align=left;" vertex="1" connectable="0" parent="L0__EUAIFv-v6VTxFZ8R-51">
|
||||
<mxGeometry x="52.25" y="50" width="180" height="90" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="L0__EUAIFv-v6VTxFZ8R-54" style="vsdxID=12;fillColor=#0050ef;shape=stencil(nZBLDoAgDERP0z3SIyjew0SURgSD+Lu9kMZoXLhwN9O+tukAlrNpJg1SzDH4QW/URgNYgZTkjA4UkwJUgGXng+6DX1zLfmoymdXo17xh5zmRJ6Q42BWCfc2oJfdAr+Yv+AP9Cb7OJ3H/2JG1HNGz/84klThPVCc=);strokeColor=#001DBC;strokeWidth=3;labelBackgroundColor=none;rounded=0;html=1;whiteSpace=wrap;fontColor=#ffffff;" vertex="1" parent="L0__EUAIFv-v6VTxFZ8R-53">
|
||||
<mxGeometry width="180" height="90" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="L0__EUAIFv-v6VTxFZ8R-55" value="<font data-darkreader-inline-color="" style="font-size: 28px; font-family: &quot;calibri&quot;; color: rgb(255, 255, 255); direction: ltr; letter-spacing: 0px; line-height: 120%; opacity: 1; --darkreader-inline-color: #e8e6e3;">Mumble Server</font>" style="verticalAlign=middle;align=center;vsdxID=25;fillColor=none;shape=stencil(nZBLDoAgDERP0z3SIyjew0SURgSD+Lu9kMZoXLhwN9O+tukAlrNpJg1SzDH4QW/URgNYgZTkjA4UkwJUgGXng+6DX1zLfmoymdXo17xh5zmRJ6Q42BWCfc2oJfdAr+Yv+AP9Cb7OJ3H/2JG1HNGz/84klThPVCc=);strokeColor=none;labelBackgroundColor=none;rounded=0;html=1;whiteSpace=wrap;" vertex="1" parent="L0__EUAIFv-v6VTxFZ8R-53">
|
||||
<mxGeometry x="8.826923076923094" y="27.64285714285714" width="162.34615384615387" height="47.57142857142858" as="geometry" />
|
||||
</mxCell>
|
||||
</root>
|
||||
</mxGraphModel>
|
||||
</diagram>
|
||||
</mxfile>
|
||||
BIN
content/docs/overview/design-overview.drawio.png
Normal file
BIN
content/docs/overview/design-overview.drawio.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 174 KiB |
BIN
content/docs/overview/flake_controller_new.epgz
Normal file
BIN
content/docs/overview/flake_controller_new.epgz
Normal file
Binary file not shown.
BIN
content/docs/overview/flake_controller_new.png
Normal file
BIN
content/docs/overview/flake_controller_new.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 29 KiB |
272
content/docs/overview/index.md
Normal file
272
content/docs/overview/index.md
Normal file
@ -0,0 +1,272 @@
|
||||
+++
|
||||
title = "Technical Overview"
|
||||
description = "Overview of cLAN's architecture, components and security"
|
||||
date = 2021-05-01T18:10:00+00:00
|
||||
updated = 2021-07-13T18:10:00+00:00
|
||||
draft = false
|
||||
weight = 410
|
||||
sort_by = "weight"
|
||||
template = "docs/page.html"
|
||||
|
||||
[extra]
|
||||
lead = "Overview of cLAN's architecture, components and security"
|
||||
toc = true
|
||||
top = false
|
||||
+++
|
||||
|
||||
|
||||
### cLAN
|
||||
|
||||
cLAN envisions a new model for a decentralized network, designed to provide families, smaller groups, and small businesses a platform that's private, secure, and user-friendly. The system transcends the conventional reliance on centralized services, allowing for direct, end-to-end encrypted communication among users. Rooted in open-source software, cLAN ensures no vendor lock-in, and introduces robust features including remote management, backup functionality, user-friendly app store, and fleet management for small businesses.
|
||||
|
||||
|
||||
### Decentralized Network Model
|
||||
|
||||
cLAN incorporates a decentralized network model to tackle the challenges posed by restrictive firewalls, NAT, and the scarcity of ipv4 address space. By leveraging end-to-end encryption, the model ensures all peers within the network are fully connected, allowing services and communication to occur directly.
|
||||
This is achieved by the user of an decentralized virtual private network (VPN). A decentralized VPN is a system that uses multiple servers spread across different locations to create a secure, private network within an organization, enabling secure communication and data transfer without relying on a central server. The VPN serves as an added layer of security, shielding internal services from exposure to the open internet.
|
||||
|
||||
This network model uses a decentralized method, similar to a phonebook, that translates website names into addresses that computers understand (i.e. using mDNS), which helps improve how users interact with the network. Looking forward, for businesses, the model plans to include rules that decide who can access which parts of the network, depending on their job role.
|
||||
|
||||
<!--
|
||||
We will not add this to the initial prototype...
|
||||
|
||||
### On-boarding and communication
|
||||
|
||||
* Motivation: To help on-boarding new people to a group or to communicate within the group, the network needs some form of a communication channel.
|
||||
* Members of the group have different roles (admins, moderators)
|
||||
* Chat-ops: Bots help administrating the network, i.e. allow new peers, deploy to new applications to nodes, query health status of services, alerting/monitoring
|
||||
* For new users we also need a way to expose the chat outside of network to help them joining the network
|
||||
* For now we plan to use the Matrix protocol which gives us the following advantages:
|
||||
* End-to-end decryption and authentication
|
||||
* Decentralized rooms (multiple servers)
|
||||
* Good client support for many platforms
|
||||
* Installation
|
||||
-->
|
||||
|
||||
|
||||
### NixOS as the Operating System
|
||||
|
||||
* Motivation: Maintaining and configuring a decentralized system like cLAN with heterogeneous services on heterogeneous platforms is a challenging task. In professional setups this is usually solved by the use of configuration management. These systems require years of experience and are therefore not approchable by normal users. The solution so far to this problem is to provide instead appliances that are massivly locked in functionality or platforms they support.
|
||||
* To overcome these limitations, we propose NixOS.
|
||||
* NixOS is an operating system that uses a single declarative and consistent configuration to describe the whole system using its own programming language called Nix
|
||||
* While Nix is not necessarily more user-friendly, we believe it's still the best fit to be configured through graphical user interface for the following reasons: The underlying data structures is simple enough to be generated from a user interface / assistant. Because it's declarative unlike other many configuration management systems, different modules can be composed and applied in any order.
|
||||
* Especially in distributed setup where the adminstrator does not necessarily has physical access to the computers that require updates, NixOS provides atomic updates and rollbacks in case an update fail. We like to extend these capabilities with automatic rollbacks to make it easier to recover from a misconfiguration
|
||||
* A user can join one or multiple networks.
|
||||
* We use virtual machines (or containers) to isolate these networks.
|
||||
* A virtual machine is a software-based imitation of a physical computer. It runs its own operating system, independent of the host machine's, allowing multiple virtual mahcines with varied configurations to operate simultaneously on one physical device. Virtual machines are often used for software testing, running outdated applications, and isolating potential security threats.
|
||||
* Applications inside of virtual machines for users are preconfigured for services offered by the network
|
||||
|
||||
The Nix configuration language allows the complete configurability and modifiability of any system it is applied to, regardless of complexity and size. It is used as the basis for NixOS to create a completely reproducible operating system, where the configuration of software services running on those machines is easily shared by using small, human-readable small code snippets called "NixOS Configurations". When using Nix and NixOS, software appears out of thin air, correctly configured the way you intended, each and every time.
|
||||
|
||||
Nixpkgs is a collection of recipes, also referred to as "derivations", which allow the building, sharing and reproduction of an incredibly large set of computer software. These programs are compiled from source, which means they can be modified or sovereignly maintained. These build instructions are written in the Nix programming language.
|
||||
|
||||
Nixpkgs also defines "modules" which permit the sharing of knowledge and implementation on how to run this software correctly. The past 50 years of operating system development and best practices has been encoded in Nixpkgs by legions of contributors. Sharing of esoteric system administration knowledge, previously inaccessible and fragmented across industry experts, has been made easy due to this work.
|
||||
|
||||
From the perspective of the user, software and systems that once required years of experience to provision, can now be boiled down to a single, short Nix expression; a single line of code in most cases.
|
||||
|
||||
|
||||
### Self-hosted backup and restore
|
||||
|
||||
cLAN enables users to easily self-host and backup their data, since one of the perils of self-hosting is data loss. Users can build pre-configured servers from the interface where they also would be notified about devices not being backed up and view information about the storage device, such as available storage and state of arrays.
|
||||
|
||||
It is possible for users to back up devices in their global network, regardless of how they are connected. Services installed provided by cLAN also need to be aware of the backup process i.e. some applications, such as databases, have custom backup and restore procedures that needs to be integrated in the backup procedure.
|
||||
|
||||
|
||||
|
||||
## Components
|
||||
|
||||
<!-- source: https://cgit.lassul.us/project-x-docs/ -->
|
||||
<img width="100%" src="design-overview.drawio.png" alt="Design">
|
||||
(figure 1)
|
||||
|
||||
### Base-OS
|
||||
|
||||
Initially, we will utilize NixOS as the foundational operating system for hosting network-specific virtual machines. Presently, the installation process of NixOS involves advanced technical knowledge, including a degree of proficiency in its unique programming language. However, our solution cLAN aims to simplify this process, enabling even non-technical individuals to successfully install the system.
|
||||
|
||||
Several approaches can be considered to simplify the Base OS installation process:
|
||||
|
||||
* Quick-to-implement solutions:
|
||||
* Develop an installer that establishes a connection to a Virtual Private Network (VPN). This would enable a more proficient user or administrator to provide assistance or even conduct the installation process on behalf of the user.
|
||||
* Design an installer capable of autonomously installing the operating system when initiated, for instance, via PXE (Preboot eXecution Environment) or USB.
|
||||
|
||||
* More effort-intensive approach: Enhance the existing graphical installer to minimize the degree of technical knowledge (such as understanding of Nix) required by the user.
|
||||
|
||||
#### Flake configuration manager
|
||||
|
||||
<!-- TODO: network -->
|
||||
Our aim is to empower users to create a template for a virtual machine, essentially allowing them to define a flake.nix from an assortment of templates we offer as high-level NixOS modules through a graphical user-interface. The user-defined flake will contain several essential elements:
|
||||
|
||||
Documentation: We will provide detailed guides on how to join and communicate within the network, as well as an overview of what the network has to offer. These guides will help users navigate the network and utilize its features to their fullest potential.
|
||||
|
||||
Network joining configuration: To facilitate seamless connectivity, the flake will include configurations for Virtual Private Network (VPN), Domain Name System (DNS), and possibly bootstrap hosts. These configurations will ensure that users can easily join the network and maintain a stable connection.
|
||||
|
||||
A default nixos configuration: Upon spawning a virtual machine, a default NixOS configuration will be included, preloaded with various apps. This feature enables users to kickstart their virtual machine experience with ready-to-use applications, eliminating the need for manual installation and configuration.
|
||||
|
||||
Users will be able to establish their own networks and incorporate various features into it, such as a Git server, a shared Nextcloud instance, or automatic directory synchronization via Syncthing (see also 'Market Place' section below).
|
||||
|
||||
Ideally, we envision this functionality in the form of a web application, an Android app, and possibly a terminal-based application for power users. These platforms will cater to different user preferences, promoting a more inclusive and user-friendly experience.
|
||||
|
||||
an example flake.nix for a virtual machine network:
|
||||
|
||||
```nix
|
||||
{
|
||||
inputs.cLAN.url = "git+https://git.cLAN.com/cLAN";
|
||||
|
||||
outputs = { self, cLAN, ... }:
|
||||
{
|
||||
nixosModules = {
|
||||
default = inputs.cLAN.nixosSystem {
|
||||
imports = [
|
||||
cLAN.nixosModules.default
|
||||
];
|
||||
cLAN = {
|
||||
adminMode = "local";
|
||||
networkLayer= "yggdrasil";
|
||||
applications = {
|
||||
syncthing = {
|
||||
enable = true;
|
||||
sharedFolders = [ "/shared/docs" ];
|
||||
};
|
||||
mumbleClient.server = "mumble.cLAN";
|
||||
};
|
||||
};
|
||||
};
|
||||
};
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
To build the final VM,
|
||||
This modules would be build by the VM controller into a system with the following flake.nix
|
||||
|
||||
```nix
|
||||
{
|
||||
inputs.myNetworkFlake = "git+https://somurl-where-I-can-get-flake.nix-from-above";
|
||||
|
||||
outputs = inputs:
|
||||
{
|
||||
nixosConfigurations.me = inputs.myNetworkFlake.inputs.nixpkgs.lib.nixosSystem {
|
||||
imports = [
|
||||
inputs.myNetworkFlake.nixosModules.default
|
||||
./local-overrides.nix
|
||||
];
|
||||
};
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
the upper flake.nix can also be split into a boilerplate flake.nix and a json, which can be generated by a graphical interface.
|
||||
|
||||
```nix
|
||||
{
|
||||
inputs.cLAN.url = "git+https://git.cLAN.com/cLAN";
|
||||
|
||||
outputs = { self, cLAN, ... }:
|
||||
{
|
||||
nixosModules = cLAN.lib.generateNixosModules (builtins.fromJSON (import ./configs.json));
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
configs.json
|
||||
|
||||
```json
|
||||
{
|
||||
"default": {
|
||||
"system": "x86_64-linux",
|
||||
"adminMode": "local",
|
||||
"networkLayer": "yggdrasil",
|
||||
"applications": {
|
||||
"syncthing": {
|
||||
"enable": true,
|
||||
"sharedFolders": [ "/shared/docs" ]
|
||||
},
|
||||
"mumbleClient": {
|
||||
"server": "mumble.cLAN"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
<!-- A crude example of how this interface would look like
|
||||
<img width="100%" src="flake_controller_new.png" alt="VM Manager New Network">
|
||||
-->
|
||||
|
||||
### VM Manager
|
||||
|
||||
The Base OS runs the VM Manager for monitoring and managing installed virtual machines. The VM Manager is a graphical interface that allows for various settings adjustments, such as enabling automatic updates, and the addition of new virtual machines.
|
||||
|
||||
Virtual machines are tight to a specific VPN of a particular group, and their configurations are obtained from a remotely accessible flake. A flake is a collection of Nix code that comprehensively outlines the virtual machine's configuration. Virtual machines can be built and updated based on this flake. Networks can advertise their flakes via a Uniform Resource Identifier (URI) such as `nix://https-github.com/someorg/somerepo`, `nix://ipfs-$someIpfsHash`, or `nix://ygg-$someYggAddr`. These URIs can be automatically opened in the virtual manager graphical interface on a user's system when clicked, making the process of joining a network straightforward and efficient.
|
||||
|
||||
If a user intends to join only a single network and their hardware capabilities are limited, an alternative to consider would be to forego the use of a virtual machine. Instead, the network configuration could be integrated directly into the Base-OS to optimize performance and enhance the user experience.
|
||||
|
||||
<img width="100%" src="proxmox.png" alt="Proxmox">
|
||||
|
||||
The interface to the VM-manager for network admins is very similiar to the proxmox interface used for managing multiple VM nodes. Showing a list of networks and corresponding VMs on the left with a detail view and monitoring/log stats in the middle. Information and Interaction with the target system is provided by the Controller described in the next section.
|
||||
|
||||
### Virtual machine controller
|
||||
|
||||
<img width="100%" src="vm-controller.drawio.png" alt="Controller">
|
||||
(figure 2)
|
||||
|
||||
The Virtual Machine (VM) Manager operates on the Base OS, while the VM Controller functions within the virtual machine itself. The latter's role is to regulate the operating system within the VM, and can be managed by either the network administrator or the local user in control of the Base OS. Here are the different modes of control:
|
||||
|
||||
* Remote Control: The network administrator can remotely access the machine using SSH. There's also a user-friendly interface for adjusting configuration settings, viewing computer statistics, or initiating a rebuild.
|
||||
* Local Control: The network administrator sets up a flake which outlines the default services, like VPN and default applications. The local administrator, with root access, can then deploy their services, such as nginx, nextcloud etc., which are integrated with the defaults provided by the flake.
|
||||
* Shared Control: Both the network and local administrators have complete access. While the local user can modify options defined by the flake.nix, either administrator can revoke these changes.
|
||||
|
||||
In order to appeal to a wider audience beyond those already familiar with Nix/NixOS, we're suggesting the development of an easy-to-understand graphical interface. This interface will simplify the use of NixOS modules, provide vital monitoring and debugging information, and enable users to manage their individual virtual machines and NixOS installations more effectively.
|
||||
|
||||
### Market place
|
||||
|
||||
* There is some kind of store/market place where people can publish their flakes/networks
|
||||
* Their source code will reside in their own repo, we might want some mirror (ipfs) in case their infrastructure goes down
|
||||
* Donation/subscription fees for maintaining and creating flakes
|
||||
|
||||
|
||||
### Private network
|
||||
|
||||
* Adding a VPN should be the default for every flake.nix created by the wizard so people can easily communicate with each other and not care about extensive firewalling/ACLS/port forwarding etc. We can support different technologies like wireguard, tinc, yggdrasil, zerotier etc. Different higher level modules have to be created for that.
|
||||
|
||||
### Integration into baseOS window manager
|
||||
|
||||
* We want an integration with the i3/sway window manager where every workspace is it's own VM. At a later point we also want integration for a more common stacking WM (like Gnome).
|
||||
|
||||
## Security
|
||||
|
||||
The flake.nix describes a system which runs inside a virtual machine. It is evaluated on the system which then builds a virtual machine out of it via Nix. This way there is no interaction with the root operating system, except through the nix-daemon.
|
||||
At a later point we can also build containers with the same system and have shared memory, gpu access and generally less overhead. Although additional safety measures have to be implemented for that.
|
||||
|
||||
In this section we discuss security threats and how we design the system to mitigate those.
|
||||
|
||||
### Threat-model and mitigations
|
||||
|
||||
Our threat model is based on the potential risks from various adversaries, each of which are outlined below:
|
||||
|
||||
* Malicious flakes/administrators: This includes individuals or entities with administrative privileges who intentionally act against the interests of the network users. They could manipulate configurations, grant unauthorized access, or misuse sensitive information.
|
||||
Our safeguards will include virtual machine isolation to mitigate the damage an malicious actor can do to the target system. Malicious admins/flakes can only affect the virtual machine but not the Base OS or other virtual machines from other networks. Since the configuration is based on Nix, more experienced users can review it prior to building. This makes the system more auditable compared to a binary distribution, where only ready built packages are downloaded.
|
||||
|
||||
* Malicious members in the network: These are network participants who may attempt to disrupt services, steal sensitive data, or exploit vulnerabilities. To counter this, we will implement methods for administrators to block/remove malicious actors from the network. As a long-term goal, business-oriented setups will include access control measures to regulate network access based on user roles.
|
||||
|
||||
* Attackers from outside the network: These are external entities trying to infiltrate the network to gain unauthorized access or disrupt the network's operations. These are locked outside access to the system by the VPN technology we use. Since there is no way for outside attackers to even reach a virtual machine, they are considered safe for all intents and purposes from outside attackers.
|
||||
* For attempts at lateral movement (i.e., the process of progressing through a network, system by system, in search of valuable data or to cause disruption), we will provide a default configuration for software we ship which we consider safe or hardened, to make it more difficult for an attacker to gain access to multiple systems.
|
||||
|
||||
* Mis-configuration: This refers to inadvertent errors in the setup or configuration of the network that can inadvertently expose it to risks.
|
||||
To address this, we only offer a limited set of options in our high-level modules, which either restrict or issue warnings for configurations deemed to be unsafe.
|
||||
For instance, services are exposed exclusively to the internal network and not to the wider internet, thereby offering an extra layer of security.
|
||||
|
||||
|
||||
### Trusted compute base
|
||||
|
||||
The Trusted Compute Base (TCB) refers to the core set of security-critical elements in a computing system, such as the operating system kernel, hardware, and certain crucial applications. The integrity and reliability of the TCB are vital to the security of the whole system.
|
||||
|
||||
In our case, the TCB encompasses the following key components:
|
||||
|
||||
* The underlying VPN: This crucial part of our TCB provides a secure communication channel between different peers within the network. By encrypting all data that passes through it, the VPN ensures confidentiality and integrity of communications, thus safeguarding against eavesdropping or data tampering attempts.
|
||||
|
||||
* The Hypervisor: Acting as the foundation for our virtual machines, the hypervisor manages and separates different networks, isolating them from one another. This prevents any potential cross-contamination or attacks between virtual machines, preserving the integrity and security of each separate network.
|
||||
|
||||
* Nix Sandbox Isolation: This provides a safe way to build virtual machines, binaries, etc. in an isolated environment from the operating system. With this we can utilize the native speed of the Base OS for building the OS that runs inside the virtual machines.
|
||||
70
content/docs/overview/mesh-vpn.drawio
Normal file
70
content/docs/overview/mesh-vpn.drawio
Normal file
@ -0,0 +1,70 @@
|
||||
<mxfile host="app.diagrams.net" modified="2024-01-05T12:59:03.492Z" agent="Mozilla/5.0 (X11; Linux x86_64; rv:107.0) Gecko/20100101 Firefox/107.0" etag="nRfnfGWJctDRxy5wXqNq" version="22.1.16" type="device">
|
||||
<diagram name="Page-1" id="GEtNjjdXVUXUiFOQShyp">
|
||||
<mxGraphModel dx="1818" dy="1012" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
|
||||
<root>
|
||||
<mxCell id="0" />
|
||||
<mxCell id="1" parent="0" />
|
||||
<mxCell id="ilsiUmANOehLyqSuM1yz-1" value="" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;" vertex="1" parent="1">
|
||||
<mxGeometry x="185" y="10" width="430" height="430" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="ilsiUmANOehLyqSuM1yz-7" value="" style="group" vertex="1" connectable="0" parent="1">
|
||||
<mxGeometry x="40" y="30" width="130" height="130" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="ilsiUmANOehLyqSuM1yz-6" value="" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;" vertex="1" parent="ilsiUmANOehLyqSuM1yz-7">
|
||||
<mxGeometry width="130" height="130" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="ilsiUmANOehLyqSuM1yz-2" value="" style="fontColor=#0066CC;verticalAlign=top;verticalLabelPosition=bottom;labelPosition=center;align=center;html=1;outlineConnect=0;fillColor=#CCCCCC;strokeColor=#6881B3;gradientColor=none;gradientDirection=north;strokeWidth=2;shape=mxgraph.networks.security_camera;" vertex="1" parent="ilsiUmANOehLyqSuM1yz-7">
|
||||
<mxGeometry x="15" y="25" width="100" height="80" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="ilsiUmANOehLyqSuM1yz-3" value="" style="endArrow=none;html=1;rounded=0;strokeWidth=6;fillColor=#f8cecc;strokeColor=#e01b24;exitX=0;exitY=1;exitDx=0;exitDy=0;entryX=1;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="ilsiUmANOehLyqSuM1yz-7" source="ilsiUmANOehLyqSuM1yz-6" target="ilsiUmANOehLyqSuM1yz-6">
|
||||
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
||||
<mxPoint x="-270" y="120" as="sourcePoint" />
|
||||
<mxPoint x="-150" y="30" as="targetPoint" />
|
||||
</mxGeometry>
|
||||
</mxCell>
|
||||
<mxCell id="ilsiUmANOehLyqSuM1yz-9" value="" style="verticalLabelPosition=bottom;html=1;verticalAlign=top;align=center;strokeColor=none;fillColor=#00BEF2;shape=mxgraph.azure.computer;pointerEvents=1;" vertex="1" parent="1">
|
||||
<mxGeometry x="270" y="120" width="88.89" height="80" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="ilsiUmANOehLyqSuM1yz-10" value="" style="verticalLabelPosition=bottom;html=1;verticalAlign=top;align=center;strokeColor=none;fillColor=#00BEF2;shape=mxgraph.azure.computer;pointerEvents=1;" vertex="1" parent="1">
|
||||
<mxGeometry x="355.55" y="290" width="88.89" height="80" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="ilsiUmANOehLyqSuM1yz-11" value="" style="verticalLabelPosition=bottom;html=1;verticalAlign=top;align=center;strokeColor=none;fillColor=#00BEF2;shape=mxgraph.azure.computer;pointerEvents=1;" vertex="1" parent="1">
|
||||
<mxGeometry x="440" y="120" width="88.89" height="80" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="ilsiUmANOehLyqSuM1yz-12" value="" style="endArrow=classic;startArrow=classic;html=1;rounded=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;entryPerimeter=0;exitX=0.281;exitY=0;exitDx=0;exitDy=0;exitPerimeter=0;" edge="1" parent="1" source="ilsiUmANOehLyqSuM1yz-10" target="ilsiUmANOehLyqSuM1yz-9">
|
||||
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
||||
<mxPoint x="280" y="320" as="sourcePoint" />
|
||||
<mxPoint x="330" y="270" as="targetPoint" />
|
||||
</mxGeometry>
|
||||
</mxCell>
|
||||
<mxCell id="ilsiUmANOehLyqSuM1yz-13" value="" style="endArrow=classic;startArrow=classic;html=1;rounded=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;entryPerimeter=0;exitX=0.686;exitY=0;exitDx=0;exitDy=0;exitPerimeter=0;" edge="1" parent="1" source="ilsiUmANOehLyqSuM1yz-10" target="ilsiUmANOehLyqSuM1yz-11">
|
||||
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
||||
<mxPoint x="421" y="354" as="sourcePoint" />
|
||||
<mxPoint x="344" y="210" as="targetPoint" />
|
||||
</mxGeometry>
|
||||
</mxCell>
|
||||
<mxCell id="ilsiUmANOehLyqSuM1yz-14" value="" style="endArrow=classic;startArrow=classic;html=1;rounded=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;entryPerimeter=0;exitX=0;exitY=0.5;exitDx=0;exitDy=0;exitPerimeter=0;" edge="1" parent="1" source="ilsiUmANOehLyqSuM1yz-11" target="ilsiUmANOehLyqSuM1yz-9">
|
||||
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
||||
<mxPoint x="395" y="350" as="sourcePoint" />
|
||||
<mxPoint x="344" y="210" as="targetPoint" />
|
||||
</mxGeometry>
|
||||
</mxCell>
|
||||
<mxCell id="ilsiUmANOehLyqSuM1yz-15" value="<div><font style="font-size: 19px;">cLAN<br></font></div>" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=19;fontStyle=1" vertex="1" parent="1">
|
||||
<mxGeometry x="370" y="60" width="60" height="30" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="ilsiUmANOehLyqSuM1yz-16" value="<font style="font-size: 19px;">Mesh-VPN</font>" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
|
||||
<mxGeometry x="270" y="200" width="260" height="30" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="ilsiUmANOehLyqSuM1yz-18" value="<font style="font-size: 18px;">Machine</font>" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
|
||||
<mxGeometry x="284.45" y="140" width="60" height="30" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="ilsiUmANOehLyqSuM1yz-19" value="<font style="font-size: 18px;">Machine</font>" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
|
||||
<mxGeometry x="454.45000000000005" y="140" width="60" height="30" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="ilsiUmANOehLyqSuM1yz-20" value="<font style="font-size: 18px;">Machine</font>" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
|
||||
<mxGeometry x="370" y="310" width="60" height="30" as="geometry" />
|
||||
</mxCell>
|
||||
</root>
|
||||
</mxGraphModel>
|
||||
</diagram>
|
||||
</mxfile>
|
||||
BIN
content/docs/overview/mesh-vpn.drawio.png
Normal file
BIN
content/docs/overview/mesh-vpn.drawio.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 50 KiB |
BIN
content/docs/overview/proxmox.png
Normal file
BIN
content/docs/overview/proxmox.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 140 KiB |
34
content/docs/overview/virtualisation.drawio
Normal file
34
content/docs/overview/virtualisation.drawio
Normal file
@ -0,0 +1,34 @@
|
||||
<mxfile host="app.diagrams.net" modified="2024-01-05T13:13:17.175Z" agent="Mozilla/5.0 (X11; Linux x86_64; rv:107.0) Gecko/20100101 Firefox/107.0" etag="3DFXX_tJUOXZw0FaTeN-" version="22.1.16" type="device">
|
||||
<diagram name="Page-1" id="tz5SLeF9hT5f3y39BwH8">
|
||||
<mxGraphModel dx="1434" dy="842" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
|
||||
<root>
|
||||
<mxCell id="0" />
|
||||
<mxCell id="1" parent="0" />
|
||||
<mxCell id="trWwFmtepQNAlSAXFZ74-7" value="" style="group" vertex="1" connectable="0" parent="1">
|
||||
<mxGeometry x="850" y="110" width="540" height="380.00000000000006" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="trWwFmtepQNAlSAXFZ74-8" value="" style="verticalLabelPosition=bottom;html=1;verticalAlign=top;align=center;strokeColor=none;fillColor=#00BEF2;shape=mxgraph.azure.laptop;pointerEvents=1;" vertex="1" parent="trWwFmtepQNAlSAXFZ74-7">
|
||||
<mxGeometry x="-4" width="540" height="380.00000000000006" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="trWwFmtepQNAlSAXFZ74-9" value="<div><font style="font-size: 20px;">Virtual machine</font></div>" style="swimlane;whiteSpace=wrap;html=1;" vertex="1" parent="trWwFmtepQNAlSAXFZ74-7">
|
||||
<mxGeometry x="86" y="30.4" width="360" height="129.6" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="trWwFmtepQNAlSAXFZ74-13" value="<div>Linux or MacOS</div>" style="vsdxID=12;fillColor=#0050ef;shape=stencil(nZBLDoAgDERP0z3SIyjew0SURgSD+Lu9kMZoXLhwN9O+tukAlrNpJg1SzDH4QW/URgNYgZTkjA4UkwJUgGXng+6DX1zLfmoymdXo17xh5zmRJ6Q42BWCfc2oJfdAr+Yv+AP9Cb7OJ3H/2JG1HNGz/84klThPVCc=);strokeColor=#001DBC;strokeWidth=3;labelBackgroundColor=none;rounded=0;html=1;whiteSpace=wrap;fontColor=#ffffff;fontSize=28;" vertex="1" parent="trWwFmtepQNAlSAXFZ74-7">
|
||||
<mxGeometry x="86" y="230" width="360" height="46.2" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="trWwFmtepQNAlSAXFZ74-10" value="" style="group" vertex="1" connectable="0" parent="trWwFmtepQNAlSAXFZ74-7">
|
||||
<mxGeometry x="101" y="60" width="330" height="36.2" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="trWwFmtepQNAlSAXFZ74-11" value="<font style="font-size: 20px;"><b>App</b></font>" style="vsdxID=12;fillColor=#0050ef;shape=stencil(nZBLDoAgDERP0z3SIyjew0SURgSD+Lu9kMZoXLhwN9O+tukAlrNpJg1SzDH4QW/URgNYgZTkjA4UkwJUgGXng+6DX1zLfmoymdXo17xh5zmRJ6Q42BWCfc2oJfdAr+Yv+AP9Cb7OJ3H/2JG1HNGz/84klThPVCc=);strokeColor=#001DBC;strokeWidth=3;labelBackgroundColor=none;rounded=0;html=1;whiteSpace=wrap;fontColor=#ffffff;" vertex="1" parent="trWwFmtepQNAlSAXFZ74-10">
|
||||
<mxGeometry width="330" height="36.199999999999996" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="trWwFmtepQNAlSAXFZ74-14" value="<div>QEMU</div>" style="vsdxID=12;fillColor=#0050ef;shape=stencil(nZBLDoAgDERP0z3SIyjew0SURgSD+Lu9kMZoXLhwN9O+tukAlrNpJg1SzDH4QW/URgNYgZTkjA4UkwJUgGXng+6DX1zLfmoymdXo17xh5zmRJ6Q42BWCfc2oJfdAr+Yv+AP9Cb7OJ3H/2JG1HNGz/84klThPVCc=);strokeColor=#001DBC;strokeWidth=3;labelBackgroundColor=none;rounded=0;html=1;whiteSpace=wrap;fontColor=#ffffff;fontSize=28;" vertex="1" parent="trWwFmtepQNAlSAXFZ74-7">
|
||||
<mxGeometry x="86" y="170" width="360" height="46.2" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="trWwFmtepQNAlSAXFZ74-15" value="<div>NixOS</div>" style="vsdxID=12;fillColor=#0050ef;shape=stencil(nZBLDoAgDERP0z3SIyjew0SURgSD+Lu9kMZoXLhwN9O+tukAlrNpJg1SzDH4QW/URgNYgZTkjA4UkwJUgGXng+6DX1zLfmoymdXo17xh5zmRJ6Q42BWCfc2oJfdAr+Yv+AP9Cb7OJ3H/2JG1HNGz/84klThPVCc=);strokeColor=#001DBC;strokeWidth=3;labelBackgroundColor=none;rounded=0;html=1;whiteSpace=wrap;fontColor=#ffffff;fontSize=28;" vertex="1" parent="trWwFmtepQNAlSAXFZ74-7">
|
||||
<mxGeometry x="101" y="110" width="330" height="36.2" as="geometry" />
|
||||
</mxCell>
|
||||
</root>
|
||||
</mxGraphModel>
|
||||
</diagram>
|
||||
</mxfile>
|
||||
BIN
content/docs/overview/virtualisation.drawio.png
Normal file
BIN
content/docs/overview/virtualisation.drawio.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 29 KiB |
82
content/docs/overview/vm-controller.drawio
Normal file
82
content/docs/overview/vm-controller.drawio
Normal file
@ -0,0 +1,82 @@
|
||||
<mxfile host="app.diagrams.net" modified="2023-06-25T10:07:27.291Z" agent="Mozilla/5.0 (X11; Linux x86_64; rv:107.0) Gecko/20100101 Firefox/107.0" etag="0R5u8sYTEL2zQsEBPwp4" version="21.5.0" type="device">
|
||||
<diagram name="Page-1" id="Page-1">
|
||||
<mxGraphModel dx="774" dy="506" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
|
||||
<root>
|
||||
<mxCell id="0" />
|
||||
<mxCell id="1" value="Connector" parent="0" />
|
||||
<mxCell id="r0mgfz6IdKgSaTeHQ_le-42" value="" style="group" parent="1" vertex="1" connectable="0">
|
||||
<mxGeometry x="578" y="810" width="709" height="251" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="b6oYJSDJwjR9OZKanJwb-46" value="" style="rounded=1;whiteSpace=wrap;html=1;hachureGap=4;pointerEvents=0;strokeWidth=2;" parent="r0mgfz6IdKgSaTeHQ_le-42" vertex="1">
|
||||
<mxGeometry x="119" y="-30" width="590" height="281" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="eZtIASL5zvcn_9goES__-36" value="<h2>VM Manager<br></h2>" style="vsdxID=14;fillColor=#0050ef;shape=stencil(nZBLDoAgDERP0z3SIyjew0SURgSD+Lu9kMZoXLhwN9O+tukAlrNpJg1SzDH4QW/URgNYgZTkjA4UkwJUgGXng+6DX1zLfmoymdXo17xh5zmRJ6Q42BWCfc2oJfdAr+Yv+AP9Cb7OJ3H/2JG1HNGz/84klThPVCc=);strokeColor=#001DBC;strokeWidth=3;labelBackgroundColor=none;rounded=0;html=1;whiteSpace=wrap;fontColor=#ffffff;" parent="r0mgfz6IdKgSaTeHQ_le-42" vertex="1">
|
||||
<mxGeometry x="514" y="85.53000000000011" width="181" height="49.95" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="eZtIASL5zvcn_9goES__-38" style="vsdxID=48;edgeStyle=none;startArrow=none;endArrow=classic;startSize=5;endSize=5;strokeWidth=3;strokeColor=#000000;spacingTop=0;spacingBottom=0;spacingLeft=0;spacingRight=0;verticalAlign=middle;html=1;labelBackgroundColor=#ffffff;rounded=0;entryX=0.996;entryY=0.504;entryDx=0;entryDy=0;entryPerimeter=0;exitX=0.005;exitY=0.5;exitDx=0;exitDy=0;exitPerimeter=0;startFill=0;endFill=1;" parent="r0mgfz6IdKgSaTeHQ_le-42" edge="1" target="5" source="eZtIASL5zvcn_9goES__-36">
|
||||
<mxGeometry relative="1" as="geometry">
|
||||
<mxPoint x="499" y="50.60557768924302" as="sourcePoint" />
|
||||
<mxPoint x="520" y="-180" as="targetPoint" />
|
||||
</mxGeometry>
|
||||
</mxCell>
|
||||
<mxCell id="mQ3fhrx0b4LYlkQwnVk3-25" value="" style="group" vertex="1" connectable="0" parent="r0mgfz6IdKgSaTeHQ_le-42">
|
||||
<mxGeometry x="153" y="-0.754999999999896" width="321" height="222.51999999999998" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="5" value="" style="verticalAlign=middle;align=center;vsdxID=5;shape=stencil(nZBLDoAgDERP0z3SIyjew0SURgSD+Lu9kMZoXLhwN9O+tukAlrNpJg1SzDH4QW/URgNYgZTkjA4UkwJUgGXng+6DX1zLfmoymdXo17xh5zmRJ6Q42BWCfc2oJfdAr+Yv+AP9Cb7OJ3H/2JG1HNGz/84klThPVCc=);strokeWidth=2;labelBackgroundColor=none;rounded=0;html=1;whiteSpace=wrap;" parent="mQ3fhrx0b4LYlkQwnVk3-25" vertex="1">
|
||||
<mxGeometry width="320" height="222.52" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="14" value="<font data-darkreader-inline-color="" style="font-size: 22px; font-family: &quot;calibri&quot;; color: rgb(0, 0, 0); direction: ltr; letter-spacing: 0px; line-height: 120%; opacity: 1; --darkreader-inline-color: #e8e6e3;"><font style="font-size: 28px">VM<br></font></font>" style="verticalAlign=middle;align=center;vsdxID=19;fillColor=none;gradientColor=none;shape=stencil(nZBLDoAgDERP0z3SIyjew0SURgSD+Lu9kMZoXLhwN9O+tukAlrNpJg1SzDH4QW/URgNYgZTkjA4UkwJUgGXng+6DX1zLfmoymdXo17xh5zmRJ6Q42BWCfc2oJfdAr+Yv+AP9Cb7OJ3H/2JG1HNGz/84klThPVCc=);strokeColor=none;labelBackgroundColor=none;rounded=0;html=1;whiteSpace=wrap;" parent="mQ3fhrx0b4LYlkQwnVk3-25" vertex="1">
|
||||
<mxGeometry x="1" y="140.9223306772907" width="320" height="59.33466135458167" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="eZtIASL5zvcn_9goES__-33" value="<h2>Controller Daemon</h2>" style="vsdxID=12;fillColor=#0050ef;shape=stencil(nZBLDoAgDERP0z3SIyjew0SURgSD+Lu9kMZoXLhwN9O+tukAlrNpJg1SzDH4QW/URgNYgZTkjA4UkwJUgGXng+6DX1zLfmoymdXo17xh5zmRJ6Q42BWCfc2oJfdAr+Yv+AP9Cb7OJ3H/2JG1HNGz/84klThPVCc=);strokeColor=#001DBC;strokeWidth=3;labelBackgroundColor=none;rounded=0;html=1;whiteSpace=wrap;fontColor=#ffffff;" parent="mQ3fhrx0b4LYlkQwnVk3-25" vertex="1">
|
||||
<mxGeometry x="30" y="92.02499999999989" width="260" height="48.9" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="mQ3fhrx0b4LYlkQwnVk3-18" value="<h2>Controller Frontend<br></h2>" style="vsdxID=12;fillColor=#0050ef;shape=stencil(nZBLDoAgDERP0z3SIyjew0SURgSD+Lu9kMZoXLhwN9O+tukAlrNpJg1SzDH4QW/URgNYgZTkjA4UkwJUgGXng+6DX1zLfmoymdXo17xh5zmRJ6Q42BWCfc2oJfdAr+Yv+AP9Cb7OJ3H/2JG1HNGz/84klThPVCc=);strokeColor=#001DBC;strokeWidth=3;labelBackgroundColor=none;rounded=0;html=1;whiteSpace=wrap;fontColor=#ffffff;" vertex="1" parent="mQ3fhrx0b4LYlkQwnVk3-25">
|
||||
<mxGeometry x="150" y="33.1" width="140" height="49.95" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="mQ3fhrx0b4LYlkQwnVk3-31" value="<font style="font-size: 28px;" face="calibri">(optional)</font>" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="r0mgfz6IdKgSaTeHQ_le-42">
|
||||
<mxGeometry x="562" y="20" width="60" height="30" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="mQ3fhrx0b4LYlkQwnVk3-16" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.525;entryY=0.02;entryDx=0;entryDy=0;entryPerimeter=0;strokeWidth=3;" edge="1" parent="1" source="mQ3fhrx0b4LYlkQwnVk3-21" target="mQ3fhrx0b4LYlkQwnVk3-18">
|
||||
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
||||
<mxPoint x="891.4057853270601" y="471.9920318725103" as="sourcePoint" />
|
||||
<mxPoint x="650" y="530" as="targetPoint" />
|
||||
</mxGeometry>
|
||||
</mxCell>
|
||||
<mxCell id="mQ3fhrx0b4LYlkQwnVk3-21" value="<font style="font-size: 28px;" face="calibri">Admin</font>" style="ellipse;whiteSpace=wrap;html=1;" vertex="1" parent="1">
|
||||
<mxGeometry x="896" y="420" width="120" height="80" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="15" value="<font data-darkreader-inline-color="" style="font-size: 28px; font-family: Calibri; color: rgb(0, 0, 0); direction: ltr; letter-spacing: 0px; line-height: 120%; opacity: 1; --darkreader-inline-color: #e8e6e3;">Server<br></font>" style="verticalAlign=middle;align=center;vsdxID=20;fillColor=none;gradientColor=none;shape=stencil(nZBLDoAgDERP0z3SIyjew0SURgSD+Lu9kMZoXLhwN9O+tukAlrNpJg1SzDH4QW/URgNYgZTkjA4UkwJUgGXng+6DX1zLfmoymdXo17xh5zmRJ6Q42BWCfc2oJfdAr+Yv+AP9Cb7OJ3H/2JG1HNGz/84klThPVCc=);strokeColor=none;labelBackgroundColor=none;rounded=0;html=1;whiteSpace=wrap;" parent="1" vertex="1">
|
||||
<mxGeometry x="1300" y="919.9973306772908" width="125" height="59.33466135458167" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="mQ3fhrx0b4LYlkQwnVk3-24" value="<font style="font-size: 28px;" face="calibri" color="#000000">User</font>" style="ellipse;whiteSpace=wrap;html=1;fillColor=default;fontColor=#FFFFFF;" vertex="1" parent="1">
|
||||
<mxGeometry x="1305" y="831" width="120" height="80" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="mQ3fhrx0b4LYlkQwnVk3-26" value="" style="endArrow=classic;html=1;rounded=0;entryX=1.008;entryY=0.557;entryDx=0;entryDy=0;entryPerimeter=0;strokeWidth=3;exitX=0;exitY=0.5;exitDx=0;exitDy=0;fillColor=#f5f5f5;strokeColor=#666666;" edge="1" parent="1" source="mQ3fhrx0b4LYlkQwnVk3-24" target="mQ3fhrx0b4LYlkQwnVk3-18">
|
||||
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
||||
<mxPoint x="910" y="530" as="sourcePoint" />
|
||||
<mxPoint x="907" y="853" as="targetPoint" />
|
||||
</mxGeometry>
|
||||
</mxCell>
|
||||
<mxCell id="mQ3fhrx0b4LYlkQwnVk3-27" value="<h2>Controller cli<br></h2>" style="vsdxID=12;fillColor=#0050ef;shape=stencil(nZBLDoAgDERP0z3SIyjew0SURgSD+Lu9kMZoXLhwN9O+tukAlrNpJg1SzDH4QW/URgNYgZTkjA4UkwJUgGXng+6DX1zLfmoymdXo17xh5zmRJ6Q42BWCfc2oJfdAr+Yv+AP9Cb7OJ3H/2JG1HNGz/84klThPVCc=);strokeColor=#001DBC;strokeWidth=3;labelBackgroundColor=none;rounded=0;html=1;whiteSpace=wrap;fontColor=#ffffff;" vertex="1" parent="1">
|
||||
<mxGeometry x="744" y="509.9950000000001" width="140" height="49.95" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="mQ3fhrx0b4LYlkQwnVk3-28" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.203;entryY=0.071;entryDx=0;entryDy=0;entryPerimeter=0;strokeWidth=3;" edge="1" parent="1" source="mQ3fhrx0b4LYlkQwnVk3-27" target="eZtIASL5zvcn_9goES__-33">
|
||||
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
||||
<mxPoint x="961" y="530" as="sourcePoint" />
|
||||
<mxPoint x="965" y="853" as="targetPoint" />
|
||||
</mxGeometry>
|
||||
</mxCell>
|
||||
<mxCell id="r0mgfz6IdKgSaTeHQ_le-33" value="<font style="font-size: 24px;">VPN Mesh network</font>" style="ellipse;shape=cloud;whiteSpace=wrap;html=1;" parent="1" vertex="1">
|
||||
<mxGeometry x="720" y="550" width="320" height="240" as="geometry" />
|
||||
</mxCell>
|
||||
<mxCell id="mQ3fhrx0b4LYlkQwnVk3-30" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.992;entryY=0.492;entryDx=0;entryDy=0;entryPerimeter=0;exitX=0.5;exitY=1;exitDx=0;exitDy=0;strokeWidth=3;" edge="1" parent="1" source="mQ3fhrx0b4LYlkQwnVk3-21" target="mQ3fhrx0b4LYlkQwnVk3-27">
|
||||
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
||||
<mxPoint x="950" y="520" as="sourcePoint" />
|
||||
<mxPoint x="970" y="540" as="targetPoint" />
|
||||
</mxGeometry>
|
||||
</mxCell>
|
||||
</root>
|
||||
</mxGraphModel>
|
||||
</diagram>
|
||||
</mxfile>
|
||||
BIN
content/docs/overview/vm-controller.drawio.png
Normal file
BIN
content/docs/overview/vm-controller.drawio.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 74 KiB |
42
content/docs/thevision/index.md
Normal file
42
content/docs/thevision/index.md
Normal file
@ -0,0 +1,42 @@
|
||||
+++
|
||||
title = "The Vision"
|
||||
description = "The General Vision of this Project"
|
||||
date = 2021-05-01T19:30:00+00:00
|
||||
updated = 2021-05-01T19:30:00+00:00
|
||||
draft = false
|
||||
weight = 30
|
||||
sort_by = "weight"
|
||||
paginator.next = "docs/overview/index.md"
|
||||
template = "docs/page.html"
|
||||
+++
|
||||
|
||||
|
||||
In this context, our vision defines how we envision the behavior of the final product and how users will interact with it. cLAN aims to offer a compelling alternative to the ever-increasing centralization of the internet.
|
||||
|
||||
### Decentralized Networking
|
||||
|
||||
Instead of relying on a centralized cloud accessible via the clearnet, our objective is to establish an encrypted network of interconnected computers, essentially creating a decentralized darknet, which we affectionately call a cLAN.
|
||||
|
||||
### Seamless Onboarding
|
||||
|
||||
Our vision includes providing users with a seamless experience when they join one or multiple cLANs through invitation links. Clicking the link will trigger a popup that seeks confirmation to connect to the network.
|
||||
|
||||
### Effortless VM Integration
|
||||
|
||||
During the joining process, the user's computer (referred to as the client hereafter) will download a file containing information about a virtual machine (VM). The client will then automatically set up the VM, and once complete, this VM will become part of the cLAN.
|
||||
|
||||
Users can also choose to seamlessly integrate the cLAN configuration into their base system, effectively allowing the cLAN admin(s) to remotely manage their system.
|
||||
|
||||
### Dashboard for Services
|
||||
|
||||
Once connected, users will have access to a dashboard displaying all the services offered within this specific cLAN. Within this dashboard, users can effortlessly add applications or decide to host services for fellow cLAN members, such as a Nextcloud instance or backup endpoints.
|
||||
|
||||
### Decentralization and Redundancy
|
||||
|
||||
The core idea is to ensure service decentralization without a single point of failure. If one service fails, another machine within the cLAN network can spin up a replacement service. VMs are designed to be lightweight, minimizing resource consumption.
|
||||
|
||||
### Administrative Control
|
||||
|
||||
Within a cLAN, administrators define the configuration file and have control over who becomes part of the network.
|
||||
|
||||
Go to [Technical Overview](@/docs/overview/index.md) to see more indepth details of our work.
|
||||
27
content/privacy-policy/_index.md
Normal file
27
content/privacy-policy/_index.md
Normal file
@ -0,0 +1,27 @@
|
||||
+++
|
||||
title = "Privacy Policy"
|
||||
description = "We do not use cookies and we do not collect any personal data."
|
||||
date = 2021-05-01T08:00:00+00:00
|
||||
updated = 2020-05-01T08:00:00+00:00
|
||||
draft = false
|
||||
|
||||
[extra]
|
||||
class = "page single"
|
||||
+++
|
||||
|
||||
__TLDR__: We do not use cookies and we do not collect any personal data.
|
||||
|
||||
## Website visitors
|
||||
|
||||
- No personal information is collected.
|
||||
- No information is stored in the browser.
|
||||
- No information is shared with, sent to or sold to third-parties.
|
||||
- No information is shared with advertising companies.
|
||||
- No information is mined and harvested for personal and behavioral trends.
|
||||
- No information is monetized.
|
||||
|
||||
## Contact us
|
||||
|
||||
[Contact us](mailto:admin@clan.lol) if you have any questions.
|
||||
|
||||
Effective Date: _4th July 2023_
|
||||
@ -5,7 +5,7 @@
|
||||
self',
|
||||
...
|
||||
}: let
|
||||
deployScript = pkgs.writeShellScript "deploy.sh" ''
|
||||
deployScript = pkgs.writeScript "deploy.sh" ''
|
||||
export PATH="${lib.makeBinPath [
|
||||
pkgs.coreutils
|
||||
pkgs.openssh
|
||||
@ -23,7 +23,7 @@
|
||||
rsync \
|
||||
-e "ssh -o StrictHostKeyChecking=no $sshExtraArgs" \
|
||||
-a ${self'.packages.default}/ \
|
||||
www@clan.lol:/var/www/clan.lol
|
||||
www@clan.lol:/var/www
|
||||
|
||||
if [ -e ./ssh_key ]; then
|
||||
rm ./ssh_key
|
||||
|
||||
@ -8,10 +8,12 @@
|
||||
}: {
|
||||
devShells.default = pkgs.mkShell {
|
||||
packages = [
|
||||
pkgs.bashInteractive
|
||||
pkgs.zola
|
||||
];
|
||||
inputsFrom = [
|
||||
inputs'.clan-core.devShells.default
|
||||
];
|
||||
shellHook = ''
|
||||
ln -snf "$PWD"/static "$PWD"/website/static
|
||||
'';
|
||||
};
|
||||
};
|
||||
}
|
||||
|
||||
41
flake-parts/new-post.nix
Normal file
41
flake-parts/new-post.nix
Normal file
@ -0,0 +1,41 @@
|
||||
{
|
||||
perSystem = {
|
||||
lib,
|
||||
pkgs,
|
||||
self',
|
||||
...
|
||||
}: {
|
||||
apps.new-post.program = builtins.toString (pkgs.writeShellScript "new-post.sh" ''
|
||||
export PATH="${lib.makeBinPath [
|
||||
pkgs.coreutils pkgs.gitMinimal
|
||||
]}"
|
||||
if [ -z "$1" ]; then
|
||||
echo "Usage: new-post.sh <title>"
|
||||
exit 1
|
||||
fi
|
||||
title=$(echo "$1" | tr '[:upper:]' '[:lower:]' | tr ' ' '-')
|
||||
root=$(git rev-parse --show-toplevel)
|
||||
fname="$root/content/blog/$(date +%Y-%m-%d)-$title.md"
|
||||
if [ -f "$fname" ]; then
|
||||
echo "File already exists: $fname"
|
||||
exit 1
|
||||
fi
|
||||
cat <<EOF > "$fname"
|
||||
+++
|
||||
title = "$1"
|
||||
date = "$(date --iso-8601=seconds)"
|
||||
draft = true
|
||||
template = "blog/page.html"
|
||||
[taxonomies]
|
||||
authors = [] # TODO
|
||||
[extra]
|
||||
lead = "Some lead"
|
||||
+++
|
||||
|
||||
Some text
|
||||
EOF
|
||||
echo "Created $fname"
|
||||
git add "$fname"
|
||||
'');
|
||||
};
|
||||
}
|
||||
@ -1,34 +1,75 @@
|
||||
{ self, ... }:
|
||||
{
|
||||
perSystem =
|
||||
{
|
||||
lib,
|
||||
pkgs,
|
||||
self',
|
||||
inputs',
|
||||
...
|
||||
}:
|
||||
let
|
||||
build =
|
||||
baseUrl:
|
||||
pkgs.runCommand "website" { buildInputs = [ ]; } ''
|
||||
mkdir -p $out
|
||||
cp -r ${self}/* .
|
||||
chmod -R u+w .
|
||||
self,
|
||||
inputs,
|
||||
...
|
||||
}: {
|
||||
perSystem = {
|
||||
lib,
|
||||
pkgs,
|
||||
self',
|
||||
inputs',
|
||||
...
|
||||
}: let
|
||||
build = baseUrl: pkgs.runCommand "website" {
|
||||
buildInputs = [ pkgs.zola ];
|
||||
} ''
|
||||
mkdir -p $out
|
||||
cp -r ${self}/* .
|
||||
chmod -R u+w .
|
||||
|
||||
cp -r website/* website/.* $out
|
||||
rm $out/static
|
||||
cp -r static/ $out/static
|
||||
'';
|
||||
in
|
||||
{
|
||||
packages.default = self'.packages.website;
|
||||
packages.website = build "https://clan.lol";
|
||||
packages.website-localhost = build "http://localhost:1111";
|
||||
packages.serve = pkgs.writeShellScriptBin "serve-local" ''
|
||||
echo "serving: ${self'.packages.website-localhost}"
|
||||
${pkgs.python3}/bin/python -m http.server 1111 \
|
||||
-d website
|
||||
'';
|
||||
};
|
||||
substituteInPlace config.toml --replace \
|
||||
'base_url = "https://clan.lol"' \
|
||||
'base_url = "${baseUrl}"' \
|
||||
|
||||
# generates a zola compatible .md from a clan-core/docs/**/*.md
|
||||
generatePage() {
|
||||
local sourceFile="$1"
|
||||
local targetFile="$2"
|
||||
|
||||
# generate title by reading first non-empty line of $file and stripping all '#' symbols
|
||||
title=$(sed -n '/./{p;q}' "$sourceFile" | sed 's/#*//g')
|
||||
echo "generating page from clan-core: $title"
|
||||
|
||||
# generate header with title, template, weight to make zola happy
|
||||
echo -e "+++\ntitle = \"$title\"\ntemplate = \"docs/page.html\"\nweight = 0\n+++" > "$targetFile"
|
||||
|
||||
# append everything from the file but remove header line starting with '#' and all preceding non-empty lines
|
||||
tail -n +2 "$sourceFile" >> "$targetFile"
|
||||
}
|
||||
|
||||
# inject pages from clan-core
|
||||
for dir in ${inputs.clan-core}/docs/*; do
|
||||
subdir=$(basename $dir)
|
||||
targetDir="content/docs/$subdir"
|
||||
mkdir -p "$targetDir"
|
||||
for file in ${inputs.clan-core}/docs/$subdir/*.md; do
|
||||
target="content/docs/$subdir/$(basename $file)"
|
||||
# only generate page if file doesn't start with _
|
||||
if [[ $(basename $file) == _* ]]; then
|
||||
cat "$file" > "$target"
|
||||
continue
|
||||
fi
|
||||
generatePage "$file" "$target"
|
||||
done
|
||||
done
|
||||
|
||||
# inject nixos options docs for clanCore
|
||||
cp -r ${inputs'.clan-core.packages.docs-zola-pages-core} content/docs/core-options
|
||||
|
||||
# inject nixos options docs for clanModules
|
||||
cp -r ${inputs'.clan-core.packages.docs-zola-pages-modules} content/docs/modules-options
|
||||
|
||||
zola build
|
||||
cp -r public/* public/.* $out
|
||||
'';
|
||||
in {
|
||||
packages.default = self'.packages.website;
|
||||
packages.website = build "https://clan.lol";
|
||||
packages.website-localhost = build "http://localhost:1111";
|
||||
packages.serve = pkgs.writeShellScriptBin "serve-local" ''
|
||||
echo "serving: ${self'.packages.website-localhost}"
|
||||
${pkgs.python3}/bin/python -m http.server 1111 \
|
||||
-d ${self'.packages.website-localhost}
|
||||
'';
|
||||
};
|
||||
}
|
||||
|
||||
161
flake.lock
161
flake.lock
@ -1,15 +1,63 @@
|
||||
{
|
||||
"nodes": {
|
||||
"clan-core": {
|
||||
"inputs": {
|
||||
"disko": "disko",
|
||||
"flake-parts": [
|
||||
"flake-parts"
|
||||
],
|
||||
"nixos-generators": "nixos-generators",
|
||||
"nixpkgs": [
|
||||
"nixpkgs"
|
||||
],
|
||||
"sops-nix": "sops-nix",
|
||||
"treefmt-nix": "treefmt-nix"
|
||||
},
|
||||
"locked": {
|
||||
"lastModified": 1712517122,
|
||||
"narHash": "sha256-ynjRTeXDICFXYbcMdZfl9t7TD0d9RoNzMIq14WmZl0E=",
|
||||
"ref": "refs/heads/main",
|
||||
"rev": "d89edef9a1943cbf0150fd70cde25015161410a7",
|
||||
"revCount": 2433,
|
||||
"type": "git",
|
||||
"url": "https://git.clan.lol/clan/clan-core"
|
||||
},
|
||||
"original": {
|
||||
"type": "git",
|
||||
"url": "https://git.clan.lol/clan/clan-core"
|
||||
}
|
||||
},
|
||||
"disko": {
|
||||
"inputs": {
|
||||
"nixpkgs": [
|
||||
"clan-core",
|
||||
"nixpkgs"
|
||||
]
|
||||
},
|
||||
"locked": {
|
||||
"lastModified": 1711588700,
|
||||
"narHash": "sha256-vBB5HoQVnA6c/UrDOhLXKAahEwSRccw2YXYHxD7qoi4=",
|
||||
"owner": "nix-community",
|
||||
"repo": "disko",
|
||||
"rev": "502241afa3de2a24865ddcbe4c122f4546e32092",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
"owner": "nix-community",
|
||||
"repo": "disko",
|
||||
"type": "github"
|
||||
}
|
||||
},
|
||||
"flake-parts": {
|
||||
"inputs": {
|
||||
"nixpkgs-lib": "nixpkgs-lib"
|
||||
},
|
||||
"locked": {
|
||||
"lastModified": 1719994518,
|
||||
"narHash": "sha256-pQMhCCHyQGRzdfAkdJ4cIWiw+JNuWsTX7f0ZYSyz0VY=",
|
||||
"lastModified": 1712014858,
|
||||
"narHash": "sha256-sB4SWl2lX95bExY2gMFG5HIzvva5AVMJd4Igm+GpZNw=",
|
||||
"owner": "hercules-ci",
|
||||
"repo": "flake-parts",
|
||||
"rev": "9227223f6d922fee3c7b190b2cc238a99527bbb7",
|
||||
"rev": "9126214d0a59633752a136528f5f3b9aa8565b7d",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
@ -18,13 +66,50 @@
|
||||
"type": "github"
|
||||
}
|
||||
},
|
||||
"nixlib": {
|
||||
"locked": {
|
||||
"lastModified": 1711241261,
|
||||
"narHash": "sha256-knrTvpl81yGFHIpm1SsLDApe0thFkw1cl3ISAMPmP/0=",
|
||||
"owner": "nix-community",
|
||||
"repo": "nixpkgs.lib",
|
||||
"rev": "b2a1eeef8c185f6bd27432b053ff09d773244cbc",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
"owner": "nix-community",
|
||||
"repo": "nixpkgs.lib",
|
||||
"type": "github"
|
||||
}
|
||||
},
|
||||
"nixos-generators": {
|
||||
"inputs": {
|
||||
"nixlib": "nixlib",
|
||||
"nixpkgs": [
|
||||
"clan-core",
|
||||
"nixpkgs"
|
||||
]
|
||||
},
|
||||
"locked": {
|
||||
"lastModified": 1711626141,
|
||||
"narHash": "sha256-0qV1pHeIyUZ18cp8ijQnMf7uV+Uk4+UqTCC6yGSGWvk=",
|
||||
"owner": "nix-community",
|
||||
"repo": "nixos-generators",
|
||||
"rev": "63194fceafbfe583a9eb7d16ab499adc0a6c0bc2",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
"owner": "nix-community",
|
||||
"repo": "nixos-generators",
|
||||
"type": "github"
|
||||
}
|
||||
},
|
||||
"nixpkgs": {
|
||||
"locked": {
|
||||
"lastModified": 1720768451,
|
||||
"narHash": "sha256-EYekUHJE2gxeo2pM/zM9Wlqw1Uw2XTJXOSAO79ksc4Y=",
|
||||
"lastModified": 1712439257,
|
||||
"narHash": "sha256-aSpiNepFOMk9932HOax0XwNxbA38GOUVOiXfUVPOrck=",
|
||||
"owner": "NixOS",
|
||||
"repo": "nixpkgs",
|
||||
"rev": "7e7c39ea35c5cdd002cd4588b03a3fb9ece6fad9",
|
||||
"rev": "ff0dbd94265ac470dda06a657d5fe49de93b4599",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
@ -36,21 +121,73 @@
|
||||
},
|
||||
"nixpkgs-lib": {
|
||||
"locked": {
|
||||
"lastModified": 1719876945,
|
||||
"narHash": "sha256-Fm2rDDs86sHy0/1jxTOKB1118Q0O3Uc7EC0iXvXKpbI=",
|
||||
"type": "tarball",
|
||||
"url": "https://github.com/NixOS/nixpkgs/archive/5daf0514482af3f97abaefc78a6606365c9108e2.tar.gz"
|
||||
"dir": "lib",
|
||||
"lastModified": 1711703276,
|
||||
"narHash": "sha256-iMUFArF0WCatKK6RzfUJknjem0H9m4KgorO/p3Dopkk=",
|
||||
"owner": "NixOS",
|
||||
"repo": "nixpkgs",
|
||||
"rev": "d8fe5e6c92d0d190646fb9f1056741a229980089",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
"type": "tarball",
|
||||
"url": "https://github.com/NixOS/nixpkgs/archive/5daf0514482af3f97abaefc78a6606365c9108e2.tar.gz"
|
||||
"dir": "lib",
|
||||
"owner": "NixOS",
|
||||
"ref": "nixos-unstable",
|
||||
"repo": "nixpkgs",
|
||||
"type": "github"
|
||||
}
|
||||
},
|
||||
"root": {
|
||||
"inputs": {
|
||||
"clan-core": "clan-core",
|
||||
"flake-parts": "flake-parts",
|
||||
"nixpkgs": "nixpkgs"
|
||||
}
|
||||
},
|
||||
"sops-nix": {
|
||||
"inputs": {
|
||||
"nixpkgs": [
|
||||
"clan-core",
|
||||
"nixpkgs"
|
||||
],
|
||||
"nixpkgs-stable": [
|
||||
"clan-core"
|
||||
]
|
||||
},
|
||||
"locked": {
|
||||
"lastModified": 1711855048,
|
||||
"narHash": "sha256-HxegAPnQJSC4cbEbF4Iq3YTlFHZKLiNTk8147EbLdGg=",
|
||||
"owner": "Mic92",
|
||||
"repo": "sops-nix",
|
||||
"rev": "99b1e37f9fc0960d064a7862eb7adfb92e64fa10",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
"owner": "Mic92",
|
||||
"repo": "sops-nix",
|
||||
"type": "github"
|
||||
}
|
||||
},
|
||||
"treefmt-nix": {
|
||||
"inputs": {
|
||||
"nixpkgs": [
|
||||
"clan-core",
|
||||
"nixpkgs"
|
||||
]
|
||||
},
|
||||
"locked": {
|
||||
"lastModified": 1711803027,
|
||||
"narHash": "sha256-Qic3OvsVLpetchzaIe2hJqgliWXACq2Oee6mBXa/IZQ=",
|
||||
"owner": "numtide",
|
||||
"repo": "treefmt-nix",
|
||||
"rev": "1810d51a015c1730f2fe05a255258649799df416",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
"owner": "numtide",
|
||||
"repo": "treefmt-nix",
|
||||
"type": "github"
|
||||
}
|
||||
}
|
||||
},
|
||||
"root": "root",
|
||||
|
||||
@ -4,14 +4,19 @@
|
||||
inputs = {
|
||||
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
|
||||
flake-parts.url = "github:hercules-ci/flake-parts";
|
||||
|
||||
clan-core.url = "git+https://git.clan.lol/clan/clan-core";
|
||||
clan-core.inputs.flake-parts.follows = "flake-parts";
|
||||
clan-core.inputs.nixpkgs.follows = "nixpkgs";
|
||||
};
|
||||
|
||||
outputs = inputs@{ self, flake-parts, ... }:
|
||||
outputs = inputs@{ self, flake-parts, clan-core, ... }:
|
||||
flake-parts.lib.mkFlake { inherit inputs; } ({ lib, ... }: {
|
||||
systems = [ "x86_64-linux" ];
|
||||
imports = [
|
||||
./flake-parts/deploy.nix
|
||||
./flake-parts/devShells
|
||||
./flake-parts/new-post.nix
|
||||
./flake-parts/website.nix
|
||||
];
|
||||
perSystem = {pkgs, ...}: {
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 31 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 266 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 108 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 106 KiB |
7823
static/cLAN/cLAN.ai
7823
static/cLAN/cLAN.ai
File diff suppressed because one or more lines are too long
Binary file not shown.
|
Before Width: | Height: | Size: 149 KiB |
7121
static/cLAN/cLAN.svg
7121
static/cLAN/cLAN.svg
File diff suppressed because it is too large
Load Diff
|
Before Width: | Height: | Size: 682 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 6.5 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 555 B |
Binary file not shown.
|
Before Width: | Height: | Size: 1.2 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 2.8 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 4.1 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 360 B |
Binary file not shown.
|
Before Width: | Height: | Size: 815 B |
Binary file not shown.
|
Before Width: | Height: | Size: 1.9 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 3.1 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 375 B |
Binary file not shown.
|
Before Width: | Height: | Size: 717 B |
Binary file not shown.
|
Before Width: | Height: | Size: 1.5 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 5.9 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 490 B |
Binary file not shown.
|
Before Width: | Height: | Size: 1.1 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 2.4 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 2.1 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 167 KiB After Width: | Height: | Size: 108 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 174 KiB After Width: | Height: | Size: 106 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 70 KiB After Width: | Height: | Size: 276 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 102 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 25 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 55 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 243 KiB After Width: | Height: | Size: 384 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 27 KiB |
@ -1,6 +0,0 @@
|
||||
# Script for installing NixOS VM.
|
||||
|
||||
```
|
||||
$ clan backups create turingmachine
|
||||
$ clan backups list turingmachine
|
||||
```
|
||||
@ -1,22 +0,0 @@
|
||||
{"version": 2, "width": 133, "height": 43, "timestamp": 1711383511, "env": {"SHELL": "/run/current-system/sw/bin/zsh", "TERM": "tmux-256color"}}
|
||||
[0.043597, "o", "\u001b[?2004h[\u001b[1;36mjoerg\u001b[0m@turingmachine dotfiles]$ "]
|
||||
[0.657845, "o", "\u001b[7mclan backups create turingmachine\u001b[27m"]
|
||||
[1.063664, "o", "\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\bclan backups create turingmachine\r\n\u001b[?2004l\r"]
|
||||
[1.150332, "o", "\u001b[32mINFO\u001b[0m: creating backup for turingmachine\r\n"]
|
||||
[1.173937, "o", "warning: 'show-config' is a deprecated alias for 'config show'\r\n"]
|
||||
[1.30232, "o", "Using saved setting for 'extra-substituters = https://cache.thalheim.io' from ~/.local/share/nix/trusted-settings.json.\r\nUsing saved setting for 'extra-trusted-public-keys = cache.thalheim.io-1:R7msbosLEZKrxk/lKxf9BTjOOH7Ax3H0Qj0/6wiHOgc=' from ~/.local/share/nix/trusted-settings.json.\r\n"]
|
||||
[2.054171, "o", "warning: 'show-config' is a deprecated alias for 'config show'\r\n"]
|
||||
[2.197528, "o", "Using saved setting for 'extra-substituters = https://cache.thalheim.io' from ~/.local/share/nix/trusted-settings.json.\r\nUsing saved setting for 'extra-trusted-public-keys = cache.thalheim.io-1:R7msbosLEZKrxk/lKxf9BTjOOH7Ax3H0Qj0/6wiHOgc=' from ~/.local/share/nix/trusted-settings.json.\r\n"]
|
||||
[3.445738, "o", "\u001b[32m[turingmachine]\u001b[0m \u001b[0m$ borgbackup-create\u001b[0m\r\n"]
|
||||
[3.926155, "o", "successfully started backup\r\n"]
|
||||
[3.950673, "o", "\u001b[?2004h[\u001b[1;36mjoerg\u001b[0m@turingmachine dotfiles]$ "]
|
||||
[6.363145, "o", "\u001b[7mclan backups list turingmachine\u001b[27m\r\n\r"]
|
||||
[6.63316, "o", "\u001bM\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[Cclan backups list turingmachine\r\n\r\u001bM\r\n\u001b[?2004l\r"]
|
||||
[6.743814, "o", "warning: 'show-config' is a deprecated alias for 'config show'\r\n"]
|
||||
[6.878424, "o", "Using saved setting for 'extra-substituters = https://cache.thalheim.io' from ~/.local/share/nix/trusted-settings.json.\r\nUsing saved setting for 'extra-trusted-public-keys = cache.thalheim.io-1:R7msbosLEZKrxk/lKxf9BTjOOH7Ax3H0Qj0/6wiHOgc=' from ~/.local/share/nix/trusted-settings.json.\r\n"]
|
||||
[7.59352, "o", "warning: 'show-config' is a deprecated alias for 'config show'\r\n"]
|
||||
[7.735757, "o", "Using saved setting for 'extra-substituters = https://cache.thalheim.io' from ~/.local/share/nix/trusted-settings.json.\r\nUsing saved setting for 'extra-trusted-public-keys = cache.thalheim.io-1:R7msbosLEZKrxk/lKxf9BTjOOH7Ax3H0Qj0/6wiHOgc=' from ~/.local/share/nix/trusted-settings.json.\r\n"]
|
||||
[9.009021, "o", "\u001b[32m[turingmachine]\u001b[0m \u001b[0m$ borgbackup-list\u001b[0m\r\n"]
|
||||
[13.64185, "o", "turingmachine::borg@blob64.r:/zdata/borg/turingmachine::turingmachine-turingmachine-2024-01-25T00:00:00\r\nturingmachine::borg@blob64.r:/zdata/borg/turingmachine::turingmachine-turingmachine-2024-02-08T11:00:18\r\nturingmachine::borg@blob64.r:/zdata/borg/turingmachine::turingmachine-turingmachine-2024-02-17T00:00:00.failed\r\nturingmachine::borg@blob64.r:/zdata/borg/turingmachine::turingmachine-turingmachine-2024-02-22T15:41:29\r\nturingmachine::borg@blob64.r:/zdata/borg/turingmachine::turingmachine-turingmachine-2024-02-26T15:11:21\r\nturingmachine::borg@blob64.r:/zdata/borg/turingmachine::turingmachine-turingmachine-2024-03-04T01:00:00\r\nturingmachine::borg@blob64.r:/zdata/borg/turingmachine::turingmachine-turingmachine-2024-03-07T01:00:00.failed\r\nturingmachine::borg@blob64.r:/zdata/borg/turingmachine::turingmachine-turingmachine-2024-03-09T01:00:00\r\nturingmachine::borg@blob64.r:/zdata/borg/turingmachine::turingmachine-turingmachine-2024-03-13T01:00:00\r\nturingmachine::borg@blob64.r:/zdata/borg/turingmachine::turingmachine-turingmachine-2024-03-15T11:10:51\r\nturingmachine::borg@blob64.r:/zdata/borg/turingmachine::turingmachine-turingmachine-2024-03-21T01:00:00\r\nturingmachine::borg@blob64.r:/zdata/borg/turingmachine::turingmachine-turingmachine-2024-03-22T01:00:00\r\n"]
|
||||
[13.666186, "o", "\u001b[?2004h[\u001b[1;36mjoerg\u001b[0m@turingmachine dotfiles]$ "]
|
||||
[15.053423, "o", "\u001b[?2004l\r\r\nexit\r\n"]
|
||||
@ -4,10 +4,5 @@
|
||||
$ USE_TMPDIR=1 TMPDIR=$(pwd) nix run .#nixosConfigurations.installer.config.system.build.nixos-shell
|
||||
$ clan machines install machine-to-install root@localhost:2222
|
||||
vm> poweroff
|
||||
qemu-kvm \
|
||||
-enable-kvm -m 2048 \
|
||||
-nographic \
|
||||
-usb -device u2f-passthru
|
||||
-drive file=disk.img,if=none,id=nvm \
|
||||
-device nvme,serial=deadbeef,drive=nvm
|
||||
$ qemu-kvm -enable-kvm -hda ./empty0.qcow2 -m 512 -nographic
|
||||
```
|
||||
|
||||
0
templates/.gitkeep
Normal file
0
templates/.gitkeep
Normal file
262
templates/macros/head.html
Normal file
262
templates/macros/head.html
Normal file
@ -0,0 +1,262 @@
|
||||
{% macro resource() %}
|
||||
<link rel="preload" as="font" href="{{ get_url(path="fonts/vendor/jost/jost-v4-latin-regular.woff2") | safe }}" type="font/woff2" crossorigin>
|
||||
<link rel="preload" as="font" href="{{ get_url(path="fonts/vendor/jost/jost-v4-latin-700.woff2") | safe }}" type="font/woff2" crossorigin>
|
||||
{% endmacro %}
|
||||
|
||||
|
||||
{% macro stylesheet() %}
|
||||
<link rel="stylesheet" href="{{ get_url(path="main.css") | safe }}">
|
||||
{% endmacro %}
|
||||
|
||||
|
||||
{% macro favicons() %}
|
||||
<meta name="theme-color" content="{{ config.extra.theme_color | default(value="#fff") }}">
|
||||
<link class="favicon" rel="apple-touch-icon" sizes="180x180" href="{{ get_url(path="dark-favicon/128x128.png") | safe }}">
|
||||
<link class="favicon" rel="icon" type="image/png" sizes="32x32" href="{{ get_url(path="dark-favicon/32x32.png") | safe }}">
|
||||
<link class="favicon" rel="icon" type="image/png" sizes="16x16" href="{{ get_url(path="dark-favicon/16x16.png") | safe }}">
|
||||
{% if not config.extra.is_netlify %}
|
||||
<link rel="manifest" href="{{ get_url(path="site.webmanifest") | safe }}" crossorigin>
|
||||
{% endif %}
|
||||
{% endmacro %}
|
||||
|
||||
|
||||
{# type: website or article, generally setting article for blog articles #}
|
||||
{# page_images: using for the blog single template page #}
|
||||
{# page_section: the blog single template page have to pass the parameter #}
|
||||
{# is_404: using for the 404.html template #}
|
||||
{% macro seo(
|
||||
title="",
|
||||
title_addition="",
|
||||
description="",
|
||||
type="website",
|
||||
is_home=false,
|
||||
is_404=false,
|
||||
is_page=false,
|
||||
page_images="",
|
||||
page_section="",
|
||||
created_time="2021-05-01T08:08:00+08:00",
|
||||
updated_time="2021-05-01T08:08:08+08:00"
|
||||
)
|
||||
%}
|
||||
|
||||
{% if is_404 %}
|
||||
<meta name="robots" content="noindex, follow">
|
||||
{% else %}
|
||||
<meta name="robots" content="index, follow">
|
||||
<meta name="googlebot" content="index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1">
|
||||
<meta name="bingbot" content="index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1">
|
||||
{% endif %}
|
||||
{% if current_url %}
|
||||
{% set page_url = current_url %}
|
||||
{% else %}
|
||||
{% set page_url = get_url(path="404.html") %}
|
||||
{% endif %}
|
||||
{% if current_path %}
|
||||
{% set page_path = current_path %}
|
||||
{% else %}
|
||||
{% set page_path = "/404.html" %}
|
||||
{% endif %}
|
||||
<title>{{ title ~ title_addition }}</title>
|
||||
<meta name="description" content="{{ description }}">
|
||||
<link rel="canonical" href="{{ page_url | safe }}">
|
||||
|
||||
{% if config.extra.open.enable %}
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
{% if page.extra.images %}
|
||||
{% for image in page.extra.images %}
|
||||
<meta property="twitter:image" content="{{ get_url(path=image) | safe }}">
|
||||
{% endfor %}
|
||||
{% elif section.extra.images %}
|
||||
{% for image in section.extra.images %}
|
||||
<meta property="twitter:image" content="{{ get_url(path=image) | safe }}">
|
||||
{% endfor %}
|
||||
{% elif config.extra.open.image %}
|
||||
<meta name="twitter:image" content="{{ config.base_url | safe }}/{{ config.extra.open.image }}">
|
||||
{% endif %}
|
||||
<meta name="twitter:title" content="{{ title }}">
|
||||
<meta name="twitter:description" content="{{ description }}">
|
||||
<meta name="twitter:site" content="@{{ config.extra.open.twitter_site }}">
|
||||
<meta name="twitter:creator" content="@{{ config.extra.open.twitter_creator }}">
|
||||
|
||||
<meta property="og:title" content="{{ title }}">
|
||||
<meta property="og:description" content="{{ description }}">
|
||||
<meta property="og:type" content="{{ type }}">
|
||||
<meta property="og:url" content="{{ page_url | safe }}">
|
||||
|
||||
{% if page.extra.images %}
|
||||
{% for image in page.extra.images %}
|
||||
<meta property="og:image" content="{{ get_url(path=image) | safe }}">
|
||||
{% endfor %}
|
||||
{% elif section.extra.images %}
|
||||
{% for image in section.extra.images %}
|
||||
<meta property="og:image" content="{{ get_url(path=image) | safe }}">
|
||||
{% endfor %}
|
||||
{% elif config.extra.open.image %}
|
||||
<meta property="og:image" content="{{ config.base_url | safe }}/{{ config.extra.open.image }}">
|
||||
{% endif %}
|
||||
|
||||
<meta property="og:updated_time" content="{{ updated_time }}">
|
||||
<meta property="og:site_name" content="{{ title }}">
|
||||
|
||||
{% if config.extra.open.audio %}
|
||||
<meta property="og:audio" content="{{ config.extra.open.audio }}">
|
||||
{% endif %}
|
||||
|
||||
{% if config.extra.open.locale %}
|
||||
<meta property="og:locale" content="{{ config.extra.open.locale }}">
|
||||
{% endif %}
|
||||
|
||||
{% if config.extra.open.videos %}
|
||||
{% for video in config.extra.open.videos %}
|
||||
<meta property="og:video" content="{{ get_url(path=video) }}">
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
<meta property="og:locale" content="{{ config.extra.open.og_locale }}">
|
||||
{% endif %}
|
||||
|
||||
{% if is_home and config.extra.schema %}
|
||||
{% if config.extra.schema.type == "Organization" %}
|
||||
<script type="application/ld+json">
|
||||
{
|
||||
"@context": "https://schema.org",
|
||||
"@type": "Organization",
|
||||
"url": "{{ page_path | safe }}",
|
||||
"name": "{{ title }}",
|
||||
"logo": "{{ page_path | safe }}{{ config.extra.schema.logo }}",
|
||||
"sameAs": [
|
||||
{% if config.extra.schema.twitter %}"{{ config.extra.schema.twitter | safe }}",{% endif %}
|
||||
{% if config.extra.schema.linked_in %}"{{ config.extra.schema.linked_in | safe }}",{% endif %}
|
||||
{% if config.extra.schema.github %}"{{ config.extra.schema.github | safe }}"{% endif %}
|
||||
]
|
||||
}
|
||||
</script>
|
||||
{% endif %}
|
||||
{% if config.extra.schema.type == "Person" %}
|
||||
<script type="application/ld+json">
|
||||
{
|
||||
"@context": "https://schema.org",
|
||||
"@type": "Person",
|
||||
"url": "{{ page_path | safe }}",
|
||||
"name": "{{ title }}",
|
||||
"sameAs": [
|
||||
{% if config.extra.schema.twitter %}"{{ config.extra.schema.twitter | safe }}",{% endif %}
|
||||
{% if config.extra.schema.linked_in %}"{{ config.extra.schema.linked_in | safe }}",{% endif %}
|
||||
{% if config.extra.schema.github %}"{{ config.extra.schema.github | safe }}"{% endif %}
|
||||
]
|
||||
}
|
||||
</script>
|
||||
{% endif %}
|
||||
{% if config.extra.schema.site_links_search_box %}
|
||||
<script type="application/ld+json">
|
||||
{
|
||||
"@context": "https://schema.org",
|
||||
"@type": "WebSite",
|
||||
"url": "{{ page_path | safe }}",
|
||||
"potentialAction": {
|
||||
"@type": "SearchAction",
|
||||
"target": "{{ page_path | safe }}?q={search_term_string}",
|
||||
"query-input": "required name=search_term_string"
|
||||
}
|
||||
}
|
||||
</script>
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
||||
{% if is_page and config.extra.schema.section %}
|
||||
{% if config.extra.schema.section == page_section %}
|
||||
<script type="application/ld+json">
|
||||
{
|
||||
"@context": "https://schema.org",
|
||||
"@type": "Article",
|
||||
"mainEntityOfPage": {
|
||||
"@type": "WebPage",
|
||||
"@id": "{{ page_path | safe }}"
|
||||
},
|
||||
"headline": "{{ title }}",
|
||||
"image": {{ page_images }},
|
||||
"datePublished": "{{ created_time }}",
|
||||
"dateModified": "{{ updated_time }}",
|
||||
"author": {
|
||||
"@type": "{{ config.extra.schema.type }}",
|
||||
"name": "{{ title }}"
|
||||
},
|
||||
"publisher": {
|
||||
"@type": "{{ config.extra.schema.type }}",
|
||||
"name": "{{ title }}",
|
||||
{% if config.extra.schema.type == "Organization" %}
|
||||
"logo": {
|
||||
"@type": "ImageObject",
|
||||
"url": "{{ get_url(path=config.extra.schema.logo) | replace(from=config.base_url, to="") | safe }}"
|
||||
}
|
||||
{% endif %}
|
||||
},
|
||||
"description": "{{ description }}"
|
||||
}
|
||||
</script>
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
||||
{% set url_prefix = get_url(path="/") | split(pat="://") | first %}
|
||||
{% set url_main = get_url(path="/") | split(pat="://") | last %}
|
||||
{% set url_item = url_prefix ~ "://" ~ url_main ~ "/" %}
|
||||
<script type="application/ld+json">
|
||||
{
|
||||
"@context": "http://schema.org",
|
||||
"@type": "BreadcrumbList",
|
||||
{% if page_path == "/" %}
|
||||
{
|
||||
"@type": "ListItem",
|
||||
"position": 1 ,
|
||||
"name": "Home",
|
||||
"item": "{{ url_item | safe }}"
|
||||
},
|
||||
{% else %}
|
||||
{% set paths = page_path | trim_start_matches(pat="/") | trim_end_matches(pat="/") | split(pat="/") %}
|
||||
{% for val in paths %}
|
||||
{% set name_array = val | split(pat="-") %}
|
||||
{% set_global str = "" %}
|
||||
{% for val in name_array %}
|
||||
{% set cap_val = val | capitalize %}
|
||||
{% set_global str = str ~ cap_val ~ " " %}
|
||||
{% endfor %}
|
||||
{% set name = str | trim_end_matches(pat=" ") | title %}
|
||||
{% if not index %}
|
||||
{
|
||||
"@type": "ListItem",
|
||||
"position": 1 ,
|
||||
"name": "Home",
|
||||
"item": "{{ url_item | safe }}"
|
||||
},
|
||||
{% set_global index = 2 %}
|
||||
{% set_global url_item = url_item ~ val ~ "/" %}
|
||||
{
|
||||
"@type": "ListItem",
|
||||
"position": {{ index }} ,
|
||||
"name": "{{ name }}",
|
||||
"item": "{{ url_item | safe }}"
|
||||
},
|
||||
{% else %}
|
||||
{% set_global index = index + 1 %}
|
||||
{% set_global url_item = url_item ~ val ~ "/" %}
|
||||
{
|
||||
"@type": "ListItem",
|
||||
"position": {{ index }} ,
|
||||
"name": "{{ name }}",
|
||||
"item": "{{ url_item | safe }}"
|
||||
},
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
}
|
||||
</script>
|
||||
|
||||
{% if config.extra.ganalytics %}
|
||||
<script async src="https://www.googletagmanager.com/gtag/js?id={{config.extra.ganalytics}}"></script>
|
||||
<script>
|
||||
window.dataLayer = window.dataLayer || [];
|
||||
function gtag(){dataLayer.push(arguments);}
|
||||
gtag('js', new Date());
|
||||
gtag('config', '{{config.extra.ganalytics}}');
|
||||
</script>
|
||||
{% endif %}
|
||||
{% endmacro %}
|
||||
15
templates/shortcodes/asciinema.html
Normal file
15
templates/shortcodes/asciinema.html
Normal file
@ -0,0 +1,15 @@
|
||||
<div id="{{name}}" {% if class %}class="{{ class }}"{% endif %}>
|
||||
<script src="{{ get_url(path='asciinema-player/asciinema-player.min.js') }}"></script>
|
||||
<script>
|
||||
AsciinemaPlayer.create('{{ get_url(path="videos/" ~ name) }}',
|
||||
document.getElementById("{{name}}"), {
|
||||
loop: true,
|
||||
autoPlay: true,
|
||||
controls: false,
|
||||
speed: 1.5,
|
||||
theme: "alabaster-auto"
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
|
||||
6
templates/shortcodes/video.html
Normal file
6
templates/shortcodes/video.html
Normal file
@ -0,0 +1,6 @@
|
||||
<div {% if class %}class="{{ class }}"{% endif %}>
|
||||
<video loop muted autoplay id="{{name}}">
|
||||
<source src={{ get_url(path="videos/" ~ name) }} type="video/webm">
|
||||
Your browser does not support the video tag.
|
||||
</video>
|
||||
</div>
|
||||
3
themes/adidoks/.gitignore
vendored
Normal file
3
themes/adidoks/.gitignore
vendored
Normal file
@ -0,0 +1,3 @@
|
||||
public
|
||||
.vs
|
||||
.vscode
|
||||
133
themes/adidoks/CODE_OF_CONDUCT.md
Normal file
133
themes/adidoks/CODE_OF_CONDUCT.md
Normal file
@ -0,0 +1,133 @@
|
||||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
We as members, contributors, and leaders pledge to make participation in our
|
||||
community a harassment-free experience for everyone, regardless of age, body
|
||||
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||
identity and expression, level of experience, education, socio-economic status,
|
||||
nationality, personal appearance, race, caste, color, religion, or sexual identity
|
||||
and orientation.
|
||||
|
||||
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||
diverse, inclusive, and healthy community.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to a positive environment for our
|
||||
community include:
|
||||
|
||||
* Demonstrating empathy and kindness toward other people
|
||||
* Being respectful of differing opinions, viewpoints, and experiences
|
||||
* Giving and gracefully accepting constructive feedback
|
||||
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||
and learning from the experience
|
||||
* Focusing on what is best not just for us as individuals, but for the
|
||||
overall community
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
* The use of sexualized language or imagery, and sexual attention or
|
||||
advances of any kind
|
||||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or email
|
||||
address, without their explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Enforcement Responsibilities
|
||||
|
||||
Community leaders are responsible for clarifying and enforcing our standards of
|
||||
acceptable behavior and will take appropriate and fair corrective action in
|
||||
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||
or harmful.
|
||||
|
||||
Community leaders have the right and responsibility to remove, edit, or reject
|
||||
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||
decisions when appropriate.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies within all community spaces, and also applies when
|
||||
an individual is officially representing the community in public spaces.
|
||||
Examples of representing our community include using an official e-mail address,
|
||||
posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported to the community leaders responsible for enforcement at
|
||||
<aaranxu@outlook.com>.
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the
|
||||
reporter of any incident.
|
||||
|
||||
## Enforcement Guidelines
|
||||
|
||||
Community leaders will follow these Community Impact Guidelines in determining
|
||||
the consequences for any action they deem in violation of this Code of Conduct:
|
||||
|
||||
### 1. Correction
|
||||
|
||||
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||
unprofessional or unwelcome in the community.
|
||||
|
||||
**Consequence**: A private, written warning from community leaders, providing
|
||||
clarity around the nature of the violation and an explanation of why the
|
||||
behavior was inappropriate. A public apology may be requested.
|
||||
|
||||
### 2. Warning
|
||||
|
||||
**Community Impact**: A violation through a single incident or series
|
||||
of actions.
|
||||
|
||||
**Consequence**: A warning with consequences for continued behavior. No
|
||||
interaction with the people involved, including unsolicited interaction with
|
||||
those enforcing the Code of Conduct, for a specified period of time. This
|
||||
includes avoiding interactions in community spaces as well as external channels
|
||||
like social media. Violating these terms may lead to a temporary or
|
||||
permanent ban.
|
||||
|
||||
### 3. Temporary Ban
|
||||
|
||||
**Community Impact**: A serious violation of community standards, including
|
||||
sustained inappropriate behavior.
|
||||
|
||||
**Consequence**: A temporary ban from any sort of interaction or public
|
||||
communication with the community for a specified period of time. No public or
|
||||
private interaction with the people involved, including unsolicited interaction
|
||||
with those enforcing the Code of Conduct, is allowed during this period.
|
||||
Violating these terms may lead to a permanent ban.
|
||||
|
||||
### 4. Permanent Ban
|
||||
|
||||
**Community Impact**: Demonstrating a pattern of violation of community
|
||||
standards, including sustained inappropriate behavior, harassment of an
|
||||
individual, or aggression toward or disparagement of classes of individuals.
|
||||
|
||||
**Consequence**: A permanent ban from any sort of public interaction within
|
||||
the community.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 2.0, available at
|
||||
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
|
||||
|
||||
Community Impact Guidelines were inspired by
|
||||
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
||||
|
||||
For answers to common questions about this code of conduct, see the FAQ at
|
||||
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
|
||||
at [https://www.contributor-covenant.org/translations][translations].
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
|
||||
[Mozilla CoC]: https://github.com/mozilla/diversity
|
||||
[FAQ]: https://www.contributor-covenant.org/faq
|
||||
[translations]: https://www.contributor-covenant.org/translations
|
||||
|
||||
28
themes/adidoks/CONTRIBUTING.md
Normal file
28
themes/adidoks/CONTRIBUTING.md
Normal file
@ -0,0 +1,28 @@
|
||||
# Contributing
|
||||
|
||||
We'd love your help! Thanks for caring about the theme of Zola.
|
||||
|
||||
## Licensing
|
||||
|
||||
This repository is under the MIT license. You can find the full text of the [license](./LICENSE) in this repository.
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
The AdiDoks theme has a [code of conduct](./CODE_OF_CONDUCT.md) that governs all sub-projects, including this one. Please respect it!
|
||||
|
||||
## Contribute to Doks
|
||||
|
||||
- Follow the [GitHub flow](https://guides.github.com/introduction/flow/).
|
||||
- Follow the [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/)
|
||||
|
||||
## Create an issue
|
||||
|
||||
- [Bug report](https://github.com/aaranxu/adidoks/issues/new?template=bug-report---.md)
|
||||
- [Feature request](https://github.com/aaranxu/adidoks/issues/new?template=feature-request---.md)
|
||||
|
||||
## Improve documentation
|
||||
|
||||
👉 The documentation lives in [`./content/docs/`](https://github.com/aaranxu/adidoks/tree/master/content/docs) of the [`adidoks` repository](https://github.com/h-enk/getdoks.org).
|
||||
|
||||
- Follow the [GitHub flow](https://guides.github.com/introduction/flow/).
|
||||
- Follow the [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/)
|
||||
20
themes/adidoks/LICENSE
Normal file
20
themes/adidoks/LICENSE
Normal file
@ -0,0 +1,20 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2021 Aaran Xu
|
||||
|
||||
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.
|
||||
177
themes/adidoks/README.md
Normal file
177
themes/adidoks/README.md
Normal file
@ -0,0 +1,177 @@
|
||||
# Zola Theme AdiDoks
|
||||
|
||||
AdiDoks is a modern documentation theme, which is a port of the Hugo
|
||||
theme [Doks](https://github.com/h-enk/doks) for Zola.
|
||||
|
||||
## Demo
|
||||
|
||||
[Live Preview](https://adidoks.netlify.app/).
|
||||
|
||||
## Requirements
|
||||
|
||||
Before using the theme, you need to install the [Zola](https://www.getzola.org/documentation/getting-started/installation/) ≥ 0.15.0.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
git clone https://github.com/aaranxu/adidoks.git
|
||||
cd adidoks
|
||||
zola serve
|
||||
# open http://127.0.0.1:1111/ in the browser
|
||||
```
|
||||
|
||||
Read more from [the document of the AdiDoks](https://adidoks.org/docs/getting-started/introduction/).
|
||||
|
||||
## Installation
|
||||
|
||||
Just earlier we showed you how to run the theme directly. Now we start to
|
||||
install the theme in an existing site step by step.
|
||||
|
||||
### Step 1: Create a new zola site
|
||||
|
||||
```bash
|
||||
zola init mysite
|
||||
```
|
||||
|
||||
### Step 2: Install AdiDoks
|
||||
|
||||
Download this theme to your themes directory:
|
||||
|
||||
```bash
|
||||
cd mysite/themes
|
||||
git clone https://github.com/aaranxu/adidoks.git
|
||||
```
|
||||
|
||||
Or install as a submodule:
|
||||
|
||||
```bash
|
||||
cd mysite
|
||||
git init # if your project is a git repository already, ignore this command
|
||||
git submodule add https://github.com/aaranxu/adidoks.git themes/adidoks
|
||||
```
|
||||
|
||||
### Step 3: Configuration
|
||||
|
||||
Enable the theme in your `config.toml` in the site directory:
|
||||
|
||||
```toml
|
||||
theme = "adidoks"
|
||||
```
|
||||
|
||||
Or copy the `config.toml.example` from the theme directory to your project's
|
||||
root directory:
|
||||
|
||||
```bash
|
||||
cp themes/adidoks/config.toml.example config.toml
|
||||
```
|
||||
|
||||
### Step 4: Add new content
|
||||
|
||||
You can copy the content from the theme directory to your project:
|
||||
|
||||
```bash
|
||||
cp -r themes/adidoks/content .
|
||||
```
|
||||
|
||||
You can modify or add new posts in the `content/blog`, `content/docs` or other
|
||||
content directories as needed.
|
||||
|
||||
### Step 5: Run the project
|
||||
|
||||
Just run `zola serve` in the root path of the project:
|
||||
|
||||
```bash
|
||||
zola serve
|
||||
```
|
||||
|
||||
AdiDoks will start the Zola development web server accessible by default at
|
||||
`http://127.0.0.1:1111`. Saved changes will live reload in the browser.
|
||||
|
||||
## Customisation
|
||||
|
||||
You can customize your configurations, templates and content for yourself. Look
|
||||
at the `config.toml`, `theme.toml`, `content` files and templates files in this
|
||||
repo for an idea.
|
||||
|
||||
### Global Configuration
|
||||
|
||||
There are some configuration options that you can customize in `config.toml`.
|
||||
|
||||
#### Configuration options before `extra` options
|
||||
|
||||
Set the authors's taxonomies for the site.
|
||||
|
||||
```toml
|
||||
taxonomies = [
|
||||
{name = "authors"},
|
||||
]
|
||||
```
|
||||
|
||||
Use search function for the content.
|
||||
|
||||
```toml
|
||||
build_search_index = true
|
||||
```
|
||||
|
||||
#### Configuration options under the `extra`
|
||||
|
||||
The following options should be under the `[extra]` in `config.toml`
|
||||
|
||||
- `language_code` - set HTML file language (default to `en-US`)
|
||||
- `theme_color` - your site's HTML color (default to `#fff`)
|
||||
- `title_separator` - the separator to your site title, like `|` and `-` (defaults to `|`)
|
||||
- `title_addition` - the additon content for the title of the homepage
|
||||
- `timeformat` - the timeformat for the blog article published date
|
||||
- `timezone` - the timezone for the blog article published date
|
||||
- `edit_page` (and `docs_repo`, `repo_branch`) - whether to show the edit page in the github repo for your docs
|
||||
- `math` (and `library`) - set KaTeX or MathJax library
|
||||
- `[extra.open]` - Open Graph + Twitter Cards for the site
|
||||
- `[extra.schema]` - set JSON-LD for the site
|
||||
- `[[extra.menu.main]]` - the header navigations for the site
|
||||
- `[[extra.menu.social]]` - the social links on the header of the page
|
||||
- `[extra.footer]` - the footer content on the left
|
||||
- `[[extra.footer.nav]]` - the footer navigations on the right
|
||||
|
||||
### Templates
|
||||
|
||||
All pages are extend to the `base.html`, and you can customize them as need.
|
||||
|
||||
### Content
|
||||
|
||||
#### Homepage
|
||||
|
||||
Go to the *content/_index.md* file to add your own homepage content.
|
||||
|
||||
- `[extra]` - the main content of the homepage
|
||||
- `[[extra.ist]]` - the lists' content of the homepage
|
||||
|
||||
#### Sections
|
||||
|
||||
Each section includes a `_index.md`, and you can customize it or add your new
|
||||
section under the `content` folder.
|
||||
|
||||
#### Pages
|
||||
|
||||
There are mainly three types of pages in the site.
|
||||
|
||||
- `blog` - blog article
|
||||
- `docs` - documentation article
|
||||
- `authors` - authors page if you need to add some information for a new author
|
||||
|
||||
## Reporting Issues
|
||||
|
||||
We use GitHub Issues as the official bug tracker for the **AdiDoks**. Please
|
||||
search [existing issues](https://github.com/aaranxu/adidoks/issues). It’s
|
||||
possible someone has already reported the same problem.
|
||||
|
||||
If your problem or idea is not addressed yet, [open a new issue](https://github.com/aaranxu/adidoks/issues/new).
|
||||
|
||||
## Contributing
|
||||
|
||||
We'd love your help! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) to learn
|
||||
about the kinds of contributions we're looking for.
|
||||
|
||||
## License
|
||||
|
||||
**AdiDoks** is distributed under the terms of the
|
||||
[MIT license](https://github.com/aaranxu/adidoks/blob/main/LICENSE).
|
||||
132
themes/adidoks/config.toml
Normal file
132
themes/adidoks/config.toml
Normal file
@ -0,0 +1,132 @@
|
||||
# The URL the site will be built for
|
||||
base_url = "https://adidoks.netlify.com"
|
||||
title = "AdiDoks"
|
||||
description = "AdiDoks is a Zola theme helping you build modern documentation websites, which is a port of the Hugo theme Doks for Zola."
|
||||
|
||||
# The default language; used in feeds and search index
|
||||
# Note: the search index doesn't support Chinese/Japanese/Korean Languages
|
||||
default_language = "en"
|
||||
|
||||
# Whether to automatically compile all Sass files in the sass directory
|
||||
compile_sass = true
|
||||
|
||||
# Whether to generate a feed file for the site
|
||||
generate_feed = true
|
||||
|
||||
# When set to "true", the generated HTML files are minified.
|
||||
minify_html = false
|
||||
|
||||
# The taxonomies to be rendered for the site and their configuration.
|
||||
taxonomies = [
|
||||
{name = "authors"}, # Basic definition: no feed or pagination
|
||||
]
|
||||
|
||||
# Whether to build a search index to be used later on by a JavaScript library
|
||||
# When set to "true", a search index is built from the pages and section
|
||||
# content for `default_language`.
|
||||
build_search_index = true
|
||||
|
||||
[languages.fi]
|
||||
title="AdiDoks"
|
||||
|
||||
|
||||
[search]
|
||||
# Whether to include the title of the page/section in the index
|
||||
include_title = true
|
||||
# Whether to include the description of the page/section in the index
|
||||
include_description = false
|
||||
# Whether to include the rendered content of the page/section in the index
|
||||
include_content = true
|
||||
|
||||
[markdown]
|
||||
# Whether to do syntax highlighting.
|
||||
# Theme can be customised by setting the `highlight_theme`
|
||||
# variable to a theme supported by Zola
|
||||
highlight_code = true
|
||||
|
||||
[extra]
|
||||
# Put all your custom variables here
|
||||
author = "Aaran Xu"
|
||||
github = "https://github.com/aaranxu"
|
||||
twitter = "https://twitter.com/aaranxu"
|
||||
email = "aaranxu@outlook.com"
|
||||
ganalytics = "" # Google Analytics code
|
||||
|
||||
# If running on netlify.app site, set to true
|
||||
is_netlify = true
|
||||
|
||||
# Set HTML file language
|
||||
language_code = "en-US"
|
||||
|
||||
# Set theme-color meta tag for Chrome browser
|
||||
theme_color = "#fff"
|
||||
|
||||
# More about site's title
|
||||
title_separator = "|" # set as |, -, _, etc
|
||||
title_addition = "Modern Documentation Theme"
|
||||
|
||||
|
||||
# Set date format in blog publish metadata
|
||||
timeformat = "%Y-%m-%d %H:%M:%S" # e.g. 2021-05-01 09:19:42
|
||||
timezone = "UTC"
|
||||
|
||||
# Edit page on reposity or not
|
||||
edit_page = false
|
||||
docs_repo = "https://github.com/aaranxu/adidoks"
|
||||
repo_branch = "main"
|
||||
|
||||
## Math settings
|
||||
# options: true, false. Enable math support globally,
|
||||
# default: false. You can always enable math on a per page.
|
||||
math = false
|
||||
library = "katex" # options: "katex", "mathjax". default is "katex".
|
||||
|
||||
## Open Graph + Twitter Cards
|
||||
[extra.open]
|
||||
enable = true
|
||||
# this image will be used as fallback if a page has no image of its own
|
||||
image = "doks.png"
|
||||
twitter_site = "aaranxu"
|
||||
twitter_creator = "aaranxu"
|
||||
facebook_author = "ichunyun"
|
||||
facebook_publisher = "ichunyun"
|
||||
og_locale = "en_US"
|
||||
|
||||
## JSON-LD
|
||||
[extra.schema]
|
||||
type = "Organization"
|
||||
logo = "logo-doks.png"
|
||||
twitter = "https://twitter.com/aaranxu"
|
||||
linked_in = ""
|
||||
github = "https://github.com/aaranxu"
|
||||
section = "blog" # see config.extra.main~url
|
||||
## Sitelinks Search Box
|
||||
site_links_search_box = false
|
||||
|
||||
|
||||
[[extra.menu.social]]
|
||||
name = "Twitter"
|
||||
pre = '<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-twitter"><path d="M23 3a10.9 10.9 0 0 1-3.14 1.53 4.48 4.48 0 0 0-7.86 3v1A10.66 10.66 0 0 1 3 4s-4 9 5 13a11.64 11.64 0 0 1-7 2c9 5 20 0 20-11.5a4.5 4.5 0 0 0-.08-.83A7.72 7.72 0 0 0 23 3z"></path></svg>'
|
||||
url = "https://twitter.com/aaranxu"
|
||||
weight = 10
|
||||
|
||||
[[extra.menu.social]]
|
||||
name = "GitHub"
|
||||
pre = '<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-github"><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37 0 0 0-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44 0 0 0 20 4.77 5.07 5.07 0 0 0 19.91 1S18.73.65 16 2.48a13.38 13.38 0 0 0-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07 0 0 0 5 4.77a5.44 5.44 0 0 0-1.5 3.78c0 5.42 3.3 6.61 6.44 7A3.37 3.37 0 0 0 9 18.13V22"></path></svg>'
|
||||
url = "https://github.com/aaranxu/adidoks"
|
||||
post = "v0.1.0"
|
||||
weight = 20
|
||||
|
||||
# Footer contents
|
||||
[extra.footer]
|
||||
info = 'Powered by <a href="https://www.netlify.com/">Netlify</a>, <a href="https://www.getzola.org/">Zola</a>, and <a href="https://github.com/aaranxu/adidoks">AdiDoks</a>'
|
||||
|
||||
[[extra.footer.nav]]
|
||||
name = "Privacy"
|
||||
url = "/privacy-policy/"
|
||||
weight = 10
|
||||
|
||||
[[extra.footer.nav]]
|
||||
name = "Code of Conduct"
|
||||
url = "/docs/contributing/code-of-conduct/"
|
||||
weight = 20
|
||||
143
themes/adidoks/config.toml.example
Normal file
143
themes/adidoks/config.toml.example
Normal file
@ -0,0 +1,143 @@
|
||||
# The URL the site will be built for
|
||||
base_url = "https://adidoks.netlify.com"
|
||||
title = "AdiDoks"
|
||||
description = "AdiDoks is a Zola theme helping you build modern documentation websites, which is a port of the Hugo theme Doks for Zola."
|
||||
|
||||
# The site theme to use.
|
||||
theme = "adidoks"
|
||||
|
||||
# The default language; used in feeds and search index
|
||||
# Note: the search index doesn't support Chinese/Japanese/Korean Languages
|
||||
default_language = "en"
|
||||
|
||||
# Whether to automatically compile all Sass files in the sass directory
|
||||
compile_sass = true
|
||||
|
||||
# Whether to generate a feed file for the site
|
||||
generate_feed = true
|
||||
|
||||
# When set to "true", the generated HTML files are minified.
|
||||
minify_html = false
|
||||
|
||||
# The taxonomies to be rendered for the site and their configuration.
|
||||
taxonomies = [
|
||||
{name = "authors"}, # Basic definition: no feed or pagination
|
||||
]
|
||||
|
||||
# Whether to build a search index to be used later on by a JavaScript library
|
||||
# When set to "true", a search index is built from the pages and section
|
||||
# content for `default_language`.
|
||||
build_search_index = true
|
||||
|
||||
[search]
|
||||
# Whether to include the title of the page/section in the index
|
||||
include_title = true
|
||||
# Whether to include the description of the page/section in the index
|
||||
include_description = false
|
||||
# Whether to include the rendered content of the page/section in the index
|
||||
include_content = true
|
||||
|
||||
[markdown]
|
||||
# Whether to do syntax highlighting.
|
||||
# Theme can be customised by setting the `highlight_theme`
|
||||
# variable to a theme supported by Zola
|
||||
highlight_code = true
|
||||
|
||||
[extra]
|
||||
# Put all your custom variables here
|
||||
author = "Aaran Xu"
|
||||
github = "https://github.com/aaranxu"
|
||||
twitter = "https://twitter.com/aaranxu"
|
||||
email = "aaranxu@outlook.com"
|
||||
|
||||
# If running on netlify.app site, set to true
|
||||
is_netlify = true
|
||||
|
||||
# Set HTML file language
|
||||
language_code = "en-US"
|
||||
|
||||
# Set theme-color meta tag for Chrome browser
|
||||
theme_color = "#fff"
|
||||
|
||||
# More about site's title
|
||||
title_separator = "|" # set as |, -, _, etc
|
||||
title_addition = "Modern Documentation Theme"
|
||||
|
||||
|
||||
# Set date format in blog publish metadata
|
||||
timeformat = "%B %e, %Y" # e.g. June 14, 2021
|
||||
timezone = "America/New_York"
|
||||
|
||||
# Edit page on reposity or not
|
||||
edit_page = false
|
||||
docs_repo = "https://github.com/aaranxu/adidoks"
|
||||
repo_branch = "main"
|
||||
|
||||
## Math settings
|
||||
# options: true, false. Enable math support globally,
|
||||
# default: false. You can always enable math on a per page.
|
||||
math = false
|
||||
library = "katex" # options: "katex", "mathjax". default is "katex".
|
||||
|
||||
## Open Graph + Twitter Cards
|
||||
[extra.open]
|
||||
enable = true
|
||||
# this image will be used as fallback if a page has no image of its own
|
||||
image = "doks.png"
|
||||
twitter_site = "aaranxu"
|
||||
twitter_creator = "aaranxu"
|
||||
facebook_author = "ichunyun"
|
||||
facebook_publisher = "ichunyun"
|
||||
og_locale = "en_US"
|
||||
|
||||
## JSON-LD
|
||||
[extra.schema]
|
||||
type = "Organization"
|
||||
logo = "logo-doks.png"
|
||||
twitter = "https://twitter.com/aaranxu"
|
||||
linked_in = ""
|
||||
github = "https://github.com/aaranxu"
|
||||
section = "blog" # see config.extra.main~url
|
||||
## Sitelinks Search Box
|
||||
site_links_search_box = false
|
||||
|
||||
|
||||
# Menu items
|
||||
[[extra.menu.main]]
|
||||
name = "Docs"
|
||||
section = "docs"
|
||||
url = "/docs/getting-started/introduction/"
|
||||
weight = 10
|
||||
|
||||
[[extra.menu.main]]
|
||||
name = "Blog"
|
||||
section = "blog"
|
||||
url = "/blog/"
|
||||
weight = 20
|
||||
|
||||
[[extra.menu.social]]
|
||||
name = "Twitter"
|
||||
pre = '<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-twitter"><path d="M23 3a10.9 10.9 0 0 1-3.14 1.53 4.48 4.48 0 0 0-7.86 3v1A10.66 10.66 0 0 1 3 4s-4 9 5 13a11.64 11.64 0 0 1-7 2c9 5 20 0 20-11.5a4.5 4.5 0 0 0-.08-.83A7.72 7.72 0 0 0 23 3z"></path></svg>'
|
||||
url = "https://twitter.com/aaranxu"
|
||||
weight = 10
|
||||
|
||||
[[extra.menu.social]]
|
||||
name = "GitHub"
|
||||
pre = '<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-github"><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37 0 0 0-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44 0 0 0 20 4.77 5.07 5.07 0 0 0 19.91 1S18.73.65 16 2.48a13.38 13.38 0 0 0-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07 0 0 0 5 4.77a5.44 5.44 0 0 0-1.5 3.78c0 5.42 3.3 6.61 6.44 7A3.37 3.37 0 0 0 9 18.13V22"></path></svg>'
|
||||
url = "https://github.com/aaranxu/adidoks"
|
||||
post = "v0.1.0"
|
||||
weight = 20
|
||||
|
||||
# Footer contents
|
||||
[extra.footer]
|
||||
info = 'Powered by <a href="https://www.netlify.com/">Netlify</a>, <a href="https://www.getzola.org/">Zola</a>, and <a href="https://github.com/aaranxu/adidoks">AdiDoks</a>'
|
||||
|
||||
[[extra.footer.nav]]
|
||||
name = "Privacy"
|
||||
url = "/privacy-policy/"
|
||||
weight = 10
|
||||
|
||||
[[extra.footer.nav]]
|
||||
name = "Code of Conduct"
|
||||
url = "/docs/contributing/code-of-conduct/"
|
||||
weight = 20
|
||||
51
themes/adidoks/content/_index.fi.md
Normal file
51
themes/adidoks/content/_index.fi.md
Normal file
@ -0,0 +1,51 @@
|
||||
+++
|
||||
title = "Nykyaikainen teema dokumentaatiolle"
|
||||
|
||||
|
||||
# The homepage contents
|
||||
[extra]
|
||||
lead = '<b>AdiDoks</b> on nykyaikainen teema dokumentaatiosivustoille. Se on portattu Zolalle Hugo-teemasta nimeltä <a href="https://github.com/h-enk/">Doks</a>.'
|
||||
url = "/docs/getting-started/introduction/"
|
||||
url_button = "Aloita"
|
||||
repo_version = "GitHub v0.1.0"
|
||||
repo_license = "Open-source MIT License."
|
||||
repo_url = "https://github.com/aaranxu/adidoks"
|
||||
|
||||
# Menu items
|
||||
[[extra.menu.main]]
|
||||
name = "Dokumentaatio"
|
||||
section = "docs"
|
||||
url = "/docs/getting-started/introduction/"
|
||||
weight = 10
|
||||
|
||||
[[extra.menu.main]]
|
||||
name = "Blogi"
|
||||
section = "blog"
|
||||
url = "/blog/"
|
||||
weight = 20
|
||||
|
||||
[[extra.list]]
|
||||
title = "Turvallisuustietoinen"
|
||||
content = 'Saat A+-arvosanoja <a href="https://observatory.mozilla.org/analyze/adidoks.org">Mozilla Observatoryssä</a> suoraan. Voit vaihtaa turvallisuusheadereita tarpeidesi mukaan.'
|
||||
|
||||
[[extra.list]]
|
||||
title = "Salamannopea ⚡️"
|
||||
content = 'Saat hyvät pisteet <a href="https://googlechrome.github.io/lighthouse/viewer/?gist=7731347bb8ce999eff7428a8e763b637">Google Lighthousessa</a> defaultina. Doks poistaa tarpeettomat css:t, esinoutaa linkit, ja lataa kuvat laiskasti.'
|
||||
|
||||
[[extra.list]]
|
||||
title = "SEO-valmis"
|
||||
content = "Käytä järkeviä oletusarvoja rakenteiselle datalle, open graphille ja Twitter-korteille. Tai muunna SEO-asetukset mieleisiksesi helposti."
|
||||
|
||||
[[extra.list]]
|
||||
title = "Fulltext-haku"
|
||||
content = "Tee hakuja sivuillesi FlexSearchilla. Muuntele indeksointiasetuksia mieleisiksesi helposti."
|
||||
|
||||
[[extra.list]]
|
||||
title = "Sivujen layoutit"
|
||||
content = "Rakenna sivuja laskeutumisivun, blogisivun tai dokumentaatiolayoutin mukaan. Lisää osioita ja komponentteja tarpeen mukaan."
|
||||
|
||||
[[extra.list]]
|
||||
title = "Dark mode"
|
||||
content = "Vaihda hämärässä käytettävään käyttöliittymäteemaan nappia painamalla. Muuta värit muuttujilla vastaamaan brändiäsi."
|
||||
|
||||
+++
|
||||
51
themes/adidoks/content/_index.md
Normal file
51
themes/adidoks/content/_index.md
Normal file
@ -0,0 +1,51 @@
|
||||
+++
|
||||
title = "Modern Documentation Theme"
|
||||
|
||||
|
||||
# The homepage contents
|
||||
[extra]
|
||||
lead = '<b>AdiDoks</b> is a modern documentation theme, which is a port of the Hugo theme <a href="https://github.com/h-enk/">Doks</a> for Zola.'
|
||||
url = "/docs/getting-started/introduction/"
|
||||
url_button = "Get started"
|
||||
repo_version = "GitHub v0.1.0"
|
||||
repo_license = "Open-source MIT License."
|
||||
repo_url = "https://github.com/aaranxu/adidoks"
|
||||
|
||||
# Menu items
|
||||
[[extra.menu.main]]
|
||||
name = "Docs"
|
||||
section = "docs"
|
||||
url = "/docs/getting-started/introduction/"
|
||||
weight = 10
|
||||
|
||||
[[extra.menu.main]]
|
||||
name = "Blog"
|
||||
section = "blog"
|
||||
url = "/blog/"
|
||||
weight = 20
|
||||
|
||||
[[extra.list]]
|
||||
title = "Security aware"
|
||||
content = 'Get A+ scores on <a href="https://observatory.mozilla.org/analyze/adidoks.org">Mozilla Observatory</a> out of the box. Easily change the default Security Headers to suit your needs.'
|
||||
|
||||
[[extra.list]]
|
||||
title = "Fast by default ⚡️"
|
||||
content = 'Get 100 scores on <a href="https://googlechrome.github.io/lighthouse/viewer/?gist=7731347bb8ce999eff7428a8e763b637">Google Lighthouse</a> by default. Doks removes unused css, prefetches links, and lazy loads images.'
|
||||
|
||||
[[extra.list]]
|
||||
title = "SEO-ready"
|
||||
content = "Use sensible defaults for structured data, open graph, and Twitter cards. Or easily change the SEO settings to your liking."
|
||||
|
||||
[[extra.list]]
|
||||
title = "Full text search"
|
||||
content = "Search your Doks site with FlexSearch. Easily customize index settings and search options to your liking."
|
||||
|
||||
[[extra.list]]
|
||||
title = "Page layouts"
|
||||
content = "Build pages with a landing page, blog, or documentation layout. Add custom sections and components to suit your needs."
|
||||
|
||||
[[extra.list]]
|
||||
title = "Dark mode"
|
||||
content = "Switch to a low-light UI with the click of a button. Change colors with variables to match your branding."
|
||||
|
||||
+++
|
||||
18
themes/adidoks/content/authors/_index.md
Normal file
18
themes/adidoks/content/authors/_index.md
Normal file
@ -0,0 +1,18 @@
|
||||
+++
|
||||
title = "Authors"
|
||||
description = "The authurs of the blog articles."
|
||||
date = 2021-04-01T08:00:00+00:00
|
||||
updated = 2021-04-01T08:00:00+00:00
|
||||
draft = false
|
||||
|
||||
# If add a new author page in this section, please add a new item,
|
||||
# and the format is as follows:
|
||||
#
|
||||
# "author-name-in-url" = "the-full-path-of-the-author-page"
|
||||
#
|
||||
# Note: We use quoted keys here.
|
||||
[extra.author_pages]
|
||||
"aaran-xu" = "authors/aaran-xu.md"
|
||||
+++
|
||||
|
||||
The authors of the blog articles.
|
||||
11
themes/adidoks/content/authors/aaran-xu.md
Normal file
11
themes/adidoks/content/authors/aaran-xu.md
Normal file
@ -0,0 +1,11 @@
|
||||
+++
|
||||
title = "Aaran Xu"
|
||||
description = "Creator of AdiDoks."
|
||||
date = 2021-04-01T08:50:45+00:00
|
||||
updated = 2021-04-01T08:50:45+00:00
|
||||
draft = false
|
||||
+++
|
||||
|
||||
Creator of **AdiDoks**.
|
||||
|
||||
[@aaranxu](https://github.com/aaranxu)
|
||||
7
themes/adidoks/content/blog/_index.md
Normal file
7
themes/adidoks/content/blog/_index.md
Normal file
@ -0,0 +1,7 @@
|
||||
+++
|
||||
title = "Blog"
|
||||
description = "Blog"
|
||||
sort_by = "date"
|
||||
paginate_by = 2
|
||||
template = "blog/section.html"
|
||||
+++
|
||||
41
themes/adidoks/content/blog/hello-world.md
Normal file
41
themes/adidoks/content/blog/hello-world.md
Normal file
@ -0,0 +1,41 @@
|
||||
+++
|
||||
title = "Hello World"
|
||||
description = "Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default."
|
||||
date = 2021-05-01T09:19:42+00:00
|
||||
updated = 2021-05-01T09:19:42+00:00
|
||||
draft = false
|
||||
template = "blog/page.html"
|
||||
|
||||
[taxonomies]
|
||||
authors = ["Rustaceans"]
|
||||
|
||||
[extra]
|
||||
lead = "This is the source code of the traditional <b>Hello World</b> program."
|
||||
+++
|
||||
|
||||
```rust
|
||||
// This is a comment, and is ignored by the compiler
|
||||
|
||||
// This is the main function
|
||||
fn main() {
|
||||
// Statements here are executed when the compiled binary is called
|
||||
|
||||
// Print text to the console
|
||||
println!("Hello World!");
|
||||
}
|
||||
```
|
||||
|
||||
`println!` is a macro that prints text to the console.
|
||||
|
||||
A binary can be generated using the Rust compiler: `rustc`.
|
||||
|
||||
```bash
|
||||
$ rustc hello.rs
|
||||
```
|
||||
|
||||
`rustc` will produce a `hello` binary that can be executed.
|
||||
|
||||
```bash
|
||||
$ ./hello
|
||||
Hello World!
|
||||
```
|
||||
152
themes/adidoks/content/blog/markdown-syntax.md
Normal file
152
themes/adidoks/content/blog/markdown-syntax.md
Normal file
@ -0,0 +1,152 @@
|
||||
+++
|
||||
title = "Markdown Syntax Guide"
|
||||
description = "Sample article showcasing basic Markdown syntax and formatting for HTML elements."
|
||||
date = 2021-04-20T09:19:42+00:00
|
||||
updated = 2021-04-20T09:19:42+00:00
|
||||
draft = false
|
||||
template = "blog/page.html"
|
||||
|
||||
[taxonomies]
|
||||
authors = ["Public"]
|
||||
|
||||
[extra]
|
||||
lead = "This article offers a sample of basic Markdown syntax that can be used in Zola content files, also it shows whether basic HTML elements are decorated with CSS in a Zola theme."
|
||||
+++
|
||||
|
||||
## Headings
|
||||
|
||||
The following HTML `<h1>`—`<h6>` elements represent six levels of section
|
||||
headings. `<h1>` is the highest section level while `<h6>` is the lowest.
|
||||
|
||||
# H1
|
||||
## H2
|
||||
### H3
|
||||
#### H4
|
||||
##### H5
|
||||
###### H6
|
||||
|
||||
## Paragraph
|
||||
|
||||
Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum,
|
||||
voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma
|
||||
dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as
|
||||
cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin
|
||||
porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur?
|
||||
Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit
|
||||
ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda
|
||||
veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore
|
||||
eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata
|
||||
tiustia prat.
|
||||
|
||||
Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne
|
||||
sapicia is sinveli squiatum, core et que aut hariosam ex eat.
|
||||
|
||||
## Blockquotes
|
||||
|
||||
The blockquote element represents content that is quoted from another source,
|
||||
optionally with a citation which must be within a `footer` or `cite` element,
|
||||
and optionally with in-line changes such as annotations and abbreviations.
|
||||
|
||||
#### Blockquote without attribution
|
||||
|
||||
> Tiam, ad mint andaepu dandae nostion secatur sequo quae.
|
||||
> **Note** that you can use *Markdown syntax* within a blockquote.
|
||||
|
||||
#### Blockquote with attribution
|
||||
|
||||
> Don't communicate by sharing memory, share memory by communicating.<br>
|
||||
> — <cite>Rob Pike[^1]</cite>
|
||||
|
||||
> All men by nature desire to know.<br>
|
||||
> ― <cite>Aristotle[^2]</cite>
|
||||
|
||||
## Tables
|
||||
|
||||
Tables aren't part of the core Markdown spec, but Zola supports them
|
||||
out-of-the-box.
|
||||
|
||||
Name | Age
|
||||
--------|------
|
||||
Bob | 27
|
||||
Alice | 23
|
||||
|
||||
#### Inline Markdown within tables
|
||||
|
||||
| Italics | Bold | Code |
|
||||
| -------- | -------- | ------ |
|
||||
| *italics* | **bold** | `code` |
|
||||
|
||||
## Code Blocks
|
||||
|
||||
#### Code block with backticks
|
||||
|
||||
```html
|
||||
<!doctype html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Example HTML5 Document</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Test</p>
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
#### Code block indented with four spaces
|
||||
|
||||
<!doctype html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Example HTML5 Document</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Test</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
## List Types
|
||||
|
||||
#### Ordered List
|
||||
|
||||
1. First item
|
||||
2. Second item
|
||||
3. Third item
|
||||
|
||||
#### Unordered List
|
||||
|
||||
- List item
|
||||
- Another item
|
||||
- And another item
|
||||
|
||||
#### Nested list
|
||||
|
||||
- Fruit
|
||||
- Apple
|
||||
- Orange
|
||||
- Banana
|
||||
- Dairy
|
||||
- Milk
|
||||
- Cheese
|
||||
|
||||
## Other Elements — abbr, sub, sup, kbd, mark
|
||||
|
||||
<abbr title="Graphics Interchange Format">GIF</abbr> is a bitmap image format.
|
||||
|
||||
H<sub>2</sub>O
|
||||
|
||||
X<sup>n</sup> + Y<sup>n</sup> = Z<sup>n</sup>
|
||||
|
||||
Press <kbd><kbd>CTRL</kbd>+<kbd>ALT</kbd>+<kbd>Delete</kbd></kbd> to end the
|
||||
session.
|
||||
|
||||
Most <mark>salamanders</mark> are nocturnal, and hunt for insects, worms, and
|
||||
other small creatures.
|
||||
|
||||
---
|
||||
<!-- Note: There must be a blank line between every two lines of the footnote difinition. -->
|
||||
[^1]: The above quote is excerpted from Rob Pike's [talk](https://www.youtube.com/watch?v=PAAkCSZUG1c)
|
||||
during Gopherfest, November 18, 2015.
|
||||
|
||||
[^2]: The quote is the first sentence of Aristotle's [Metaphysics](http://classics.mit.edu/Aristotle/metaphysics.html).
|
||||
48
themes/adidoks/content/blog/math-typesetting.md
Normal file
48
themes/adidoks/content/blog/math-typesetting.md
Normal file
@ -0,0 +1,48 @@
|
||||
+++
|
||||
title = "Math Typesetting"
|
||||
description = "Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default."
|
||||
date = 2021-04-08T09:19:42+00:00
|
||||
updated = 2021-04-08T09:19:42+00:00
|
||||
draft = false
|
||||
template = "blog/page.html"
|
||||
|
||||
[taxonomies]
|
||||
authors = ["Public"]
|
||||
|
||||
[extra]
|
||||
lead = "Mathematical notation in a project can be enabled by using third party JavaScript libraries."
|
||||
math = true
|
||||
+++
|
||||
|
||||
|
||||
In this example we will be using [KaTeX](https://katex.org/)
|
||||
|
||||
- Create a macro under `/template/macros/math.html` with a macro named `math`.
|
||||
- Within this macro reference the [Auto-render Extension](https://katex.org/docs/autorender.html) or host these scripts locally.
|
||||
- Import the macro in your templates like so:
|
||||
|
||||
```bash
|
||||
{% import 'macros/math.html' as macros %}
|
||||
{% if page.extra.math or section.extra.math or config.extra.math %}
|
||||
{{ macros::math() }}
|
||||
{% endif %}
|
||||
```
|
||||
|
||||
- To enable KaTex globally set the parameter `extra.math` to `true` in a project's configuration
|
||||
- To enable KaTex on a per page basis include the parameter `extra.math = true` in content files
|
||||
|
||||
**Note:**
|
||||
|
||||
1. The MathJax library is the other optional choice, and you can set the parameter `extra.library` to `mathjax` in a project's configuration
|
||||
2. Use the online reference of [Supported TeX Functions](https://katex.org/docs/supported.html)
|
||||
|
||||
### Examples
|
||||
|
||||
<p>
|
||||
Inline math: \(\varphi = \dfrac{1+\sqrt5}{2}= 1.6180339887…\)
|
||||
</p>
|
||||
|
||||
Block math:
|
||||
$$
|
||||
\varphi = 1+\frac{1} {1+\frac{1} {1+\frac{1} {1+\cdots} } }
|
||||
$$
|
||||
62
themes/adidoks/content/blog/placeholder-text.md
Normal file
62
themes/adidoks/content/blog/placeholder-text.md
Normal file
@ -0,0 +1,62 @@
|
||||
+++
|
||||
title = "Placeholder Text"
|
||||
description = "Lorem Ipsum Dolor Si Amet"
|
||||
date = 2021-04-10T09:19:42+00:00
|
||||
updated = 2021-04-10T09:19:42+00:00
|
||||
draft = false
|
||||
template = "blog/page.html"
|
||||
|
||||
[taxonomies]
|
||||
authors = ["Public"]
|
||||
|
||||
+++
|
||||
|
||||
Lorem est tota propiore conpellat pectoribus de pectora summo. <!--more-->Redit
|
||||
teque digerit hominumque toris verebor lumina non cervice subde tollit usus
|
||||
habet Arctonque, furores quas nec ferunt. Quoque montibus nunc caluere tempus
|
||||
inhospita parcite confusaque translucet patri vestro qui optatis lumine
|
||||
cognoscere flos nubis! Fronde ipsamque patulos Dryopen deorum.
|
||||
|
||||
1. Exierant elisi ambit vivere dedere
|
||||
2. Duce pollice
|
||||
3. Eris modo
|
||||
4. Spargitque ferrea quos palude
|
||||
|
||||
Rursus nulli murmur; hastile inridet ut ab gravi sententia! Nomine potitus
|
||||
silentia flumen, sustinet placuit petis in dilapsa erat sunt. Atria tractus malis.
|
||||
|
||||
1. Comas hunc haec pietate fetum procerum dixit
|
||||
2. Post torum vates letum Tiresia
|
||||
3. Flumen querellas
|
||||
4. Arcanaque montibus omnes
|
||||
5. Quidem et
|
||||
|
||||
# Vagus elidunt
|
||||
|
||||
<svg class="canon" xmlns="http://www.w3.org/2000/svg" overflow="visible" viewBox="0 0 496 373" height="373" width="496"><g fill="none"><path stroke="#000" stroke-width=".75" d="M.599 372.348L495.263 1.206M.312.633l494.95 370.853M.312 372.633L247.643.92M248.502.92l246.76 370.566M330.828 123.869V1.134M330.396 1.134L165.104 124.515"></path><path stroke="#ED1C24" stroke-width=".75" d="M275.73 41.616h166.224v249.05H275.73zM54.478 41.616h166.225v249.052H54.478z"></path><path stroke="#000" stroke-width=".75" d="M.479.375h495v372h-495zM247.979.875v372"></path><ellipse cx="498.729" cy="177.625" rx=".75" ry="1.25"></ellipse><ellipse cx="247.229" cy="377.375" rx=".75" ry="1.25"></ellipse></g></svg>
|
||||
|
||||
[The Van de Graaf Canon](https://en.wikipedia.org/wiki/Canons_of_page_construction#Van_de_Graaf_canon)
|
||||
|
||||
## Mane refeci capiebant unda mulcebat
|
||||
|
||||
Victa caducifer, malo vulnere contra dicere aurato, ludit regale, voca! Retorsit
|
||||
colit est profanae esse virescere furit nec; iaculi matertera et visa est,
|
||||
viribus. Divesque creatis, tecta novat collumque vulnus est, parvas.
|
||||
**Faces illo pepulere** tempus adest. Tendit flamma, ab opes virum sustinet,
|
||||
sidus sequendo urbis.
|
||||
|
||||
Iubar proles corpore raptos vero auctor imperium; sed et huic: manus caeli
|
||||
Lelegas tu lux. Verbis obstitit intus oblectamina fixis linguisque ausus sperare
|
||||
Echionides cornuaque tenent clausit possit. Omnia putatur. Praeteritae refert
|
||||
ausus; ferebant e primus lora nutat, vici quae mea ipse. Et iter nil spectatae
|
||||
vulnus haerentia iuste et exercebat, sui et.
|
||||
|
||||
Eurytus Hector, materna ipsumque ut Politen, nec, nate, ignari, vernum cohaesit
|
||||
sequitur. Vel **mitis temploque** vocatus, inque alis, *oculos nomen* non silvis
|
||||
corpore coniunx ne displicet illa. Crescunt non unus, vidit visa quantum inmiti
|
||||
flumina mortis facto sic: undique a alios vincula sunt iactata abdita!
|
||||
Suspenderat ego fuit tendit: luna, ante urbem Propoetides **parte**.
|
||||
|
||||
<style>
|
||||
.canon { background: white; width: 100%; height: auto; }
|
||||
</style>
|
||||
15
themes/adidoks/content/blog/say-hello-to-zola-doks.md
Normal file
15
themes/adidoks/content/blog/say-hello-to-zola-doks.md
Normal file
@ -0,0 +1,15 @@
|
||||
+++
|
||||
title = "Say hello to AdiDoks 👋"
|
||||
description = "Introducing AdiDoks, a Zola theme helping you build modern documentation websites, which is a port of the Hugo theme Doks for Zola."
|
||||
date = 2021-04-03T07:00:00+00:00
|
||||
updated = 2021-04-03T07:00:00+00:00
|
||||
template = "blog/page.html"
|
||||
draft = false
|
||||
|
||||
[taxonomies]
|
||||
authors = ["Aaran Xu"]
|
||||
|
||||
[extra]
|
||||
lead = 'Introducing AdiDoks, a Zola theme helping you build modern documentation websites, which is a port of the Hugo theme <a href="https://github.com/h-enk/doks">Doks</a> for Zola.'
|
||||
images = []
|
||||
+++
|
||||
9
themes/adidoks/content/docs/_index.md
Normal file
9
themes/adidoks/content/docs/_index.md
Normal file
@ -0,0 +1,9 @@
|
||||
+++
|
||||
title = "Docs"
|
||||
description = "The documents of the AdiDoks theme."
|
||||
date = 2025-05-01T08:00:00+00:00
|
||||
updated = 2021-05-01T08:00:00+00:00
|
||||
sort_by = "weight"
|
||||
weight = 1
|
||||
template = "docs/section.html"
|
||||
+++
|
||||
10
themes/adidoks/content/docs/contributing/_index.md
Normal file
10
themes/adidoks/content/docs/contributing/_index.md
Normal file
@ -0,0 +1,10 @@
|
||||
+++
|
||||
title = "Contributing"
|
||||
description = "Find out how to contribute to AdiDoks."
|
||||
date = 2025-05-01T18:00:00+00:00
|
||||
updated = 2021-05-01T18:00:00+00:00
|
||||
template = "docs/section.html"
|
||||
sort_by = "weight"
|
||||
weight = 4
|
||||
draft = false
|
||||
+++
|
||||
146
themes/adidoks/content/docs/contributing/code-of-conduct.md
Normal file
146
themes/adidoks/content/docs/contributing/code-of-conduct.md
Normal file
@ -0,0 +1,146 @@
|
||||
+++
|
||||
title = "Code of Conduct"
|
||||
description = "Contributor Covenant Code of Conduct."
|
||||
date = 2021-05-01T18:20:00+00:00
|
||||
updated = 2021-05-01T18:20:00+00:00
|
||||
draft = false
|
||||
weight = 420
|
||||
sort_by = "weight"
|
||||
template = "docs/page.html"
|
||||
|
||||
[extra]
|
||||
lead = "Contributor Covenant Code of Conduct."
|
||||
toc = true
|
||||
top = false
|
||||
+++
|
||||
|
||||
## Our Pledge
|
||||
|
||||
We as members, contributors, and leaders pledge to make participation in our
|
||||
community a harassment-free experience for everyone, regardless of age, body
|
||||
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||
identity and expression, level of experience, education, socio-economic status,
|
||||
nationality, personal appearance, race, caste, color, religion, or sexual identity
|
||||
and orientation.
|
||||
|
||||
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||
diverse, inclusive, and healthy community.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to a positive environment for our
|
||||
community include:
|
||||
|
||||
* Demonstrating empathy and kindness toward other people
|
||||
* Being respectful of differing opinions, viewpoints, and experiences
|
||||
* Giving and gracefully accepting constructive feedback
|
||||
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||
and learning from the experience
|
||||
* Focusing on what is best not just for us as individuals, but for the
|
||||
overall community
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
* The use of sexualized language or imagery, and sexual attention or
|
||||
advances of any kind
|
||||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or email
|
||||
address, without their explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Enforcement Responsibilities
|
||||
|
||||
Community leaders are responsible for clarifying and enforcing our standards of
|
||||
acceptable behavior and will take appropriate and fair corrective action in
|
||||
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||
or harmful.
|
||||
|
||||
Community leaders have the right and responsibility to remove, edit, or reject
|
||||
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||
decisions when appropriate.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies within all community spaces, and also applies when
|
||||
an individual is officially representing the community in public spaces.
|
||||
Examples of representing our community include using an official e-mail address,
|
||||
posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported to the community leaders responsible for enforcement at
|
||||
<aaranxu@outlook.com>.
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the
|
||||
reporter of any incident.
|
||||
|
||||
## Enforcement Guidelines
|
||||
|
||||
Community leaders will follow these Community Impact Guidelines in determining
|
||||
the consequences for any action they deem in violation of this Code of Conduct:
|
||||
|
||||
### 1. Correction
|
||||
|
||||
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||
unprofessional or unwelcome in the community.
|
||||
|
||||
**Consequence**: A private, written warning from community leaders, providing
|
||||
clarity around the nature of the violation and an explanation of why the
|
||||
behavior was inappropriate. A public apology may be requested.
|
||||
|
||||
### 2. Warning
|
||||
|
||||
**Community Impact**: A violation through a single incident or series
|
||||
of actions.
|
||||
|
||||
**Consequence**: A warning with consequences for continued behavior. No
|
||||
interaction with the people involved, including unsolicited interaction with
|
||||
those enforcing the Code of Conduct, for a specified period of time. This
|
||||
includes avoiding interactions in community spaces as well as external channels
|
||||
like social media. Violating these terms may lead to a temporary or
|
||||
permanent ban.
|
||||
|
||||
### 3. Temporary Ban
|
||||
|
||||
**Community Impact**: A serious violation of community standards, including
|
||||
sustained inappropriate behavior.
|
||||
|
||||
**Consequence**: A temporary ban from any sort of interaction or public
|
||||
communication with the community for a specified period of time. No public or
|
||||
private interaction with the people involved, including unsolicited interaction
|
||||
with those enforcing the Code of Conduct, is allowed during this period.
|
||||
Violating these terms may lead to a permanent ban.
|
||||
|
||||
### 4. Permanent Ban
|
||||
|
||||
**Community Impact**: Demonstrating a pattern of violation of community
|
||||
standards, including sustained inappropriate behavior, harassment of an
|
||||
individual, or aggression toward or disparagement of classes of individuals.
|
||||
|
||||
**Consequence**: A permanent ban from any sort of public interaction within
|
||||
the community.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 2.0, available at
|
||||
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
|
||||
|
||||
Community Impact Guidelines were inspired by
|
||||
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
||||
|
||||
For answers to common questions about this code of conduct, see the FAQ at
|
||||
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
|
||||
at [https://www.contributor-covenant.org/translations][translations].
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
|
||||
[Mozilla CoC]: https://github.com/mozilla/diversity
|
||||
[FAQ]: https://www.contributor-covenant.org/faq
|
||||
[translations]: https://www.contributor-covenant.org/translations
|
||||
@ -0,0 +1,37 @@
|
||||
+++
|
||||
title = "How to Contribute"
|
||||
description = "Contribute to AdiDoks, improve documentation, or submit to showcase."
|
||||
date = 2021-05-01T18:10:00+00:00
|
||||
updated = 2021-05-01T18:10:00+00:00
|
||||
draft = false
|
||||
weight = 410
|
||||
sort_by = "weight"
|
||||
template = "docs/page.html"
|
||||
|
||||
[extra]
|
||||
lead = "Contribute to AdiDoks, improve documentation, or submit to showcase."
|
||||
toc = true
|
||||
top = false
|
||||
+++
|
||||
|
||||
👉 Make sure to read the [Code of Conduct](../code-of-conduct/).
|
||||
|
||||
## Contribute to Doks
|
||||
|
||||
👉 The AdiDoks code lives in the [`adidoks` repository](https://github.com/aaranxu/adidoks)
|
||||
|
||||
- Follow the [GitHub flow](https://guides.github.com/introduction/flow/).
|
||||
- Follow the [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/)
|
||||
|
||||
### Create an issue
|
||||
|
||||
- [Bug report](https://github.com/aaranxu/adidoks/issues/new?template=bug-report---.md)
|
||||
- [Feature request](https://github.com/aaranxu/adidoks/issues/new?template=feature-request---.md)
|
||||
|
||||
## Improve documentation
|
||||
|
||||
👉 The documentation lives in [`./content/docs/`](https://github.com/aaranxu/adidoks/tree/master/content/docs)
|
||||
of the [`adidoks` repository](https://github.com/h-enk/getdoks.org).
|
||||
|
||||
- Follow the [GitHub flow](https://guides.github.com/introduction/flow/).
|
||||
- Follow the [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/)
|
||||
10
themes/adidoks/content/docs/getting-started/_index.md
Normal file
10
themes/adidoks/content/docs/getting-started/_index.md
Normal file
@ -0,0 +1,10 @@
|
||||
+++
|
||||
title = "Getting Started"
|
||||
description = "Quick start and guides for installing the AdiDoks theme on your preferred operating system."
|
||||
date = 2025-05-01T08:00:00+00:00
|
||||
updated = 2021-05-01T08:00:00+00:00
|
||||
template = "docs/section.html"
|
||||
sort_by = "weight"
|
||||
weight = 1
|
||||
draft = false
|
||||
+++
|
||||
31
themes/adidoks/content/docs/getting-started/introduction.md
Normal file
31
themes/adidoks/content/docs/getting-started/introduction.md
Normal file
@ -0,0 +1,31 @@
|
||||
+++
|
||||
title = "Introduction"
|
||||
description = "AdiDoks is a Zola theme helping you build modern documentation websites, which is a port of the Hugo theme Doks for Zola."
|
||||
date = 2021-05-01T08:00:00+00:00
|
||||
updated = 2021-05-01T08:00:00+00:00
|
||||
draft = false
|
||||
weight = 10
|
||||
sort_by = "weight"
|
||||
template = "docs/page.html"
|
||||
|
||||
[extra]
|
||||
lead = 'AdiDoks is a Zola theme helping you build modern documentation websites, which is a port of the Hugo theme <a href="https://github.com/h-enk/doks">Doks</a> for Zola.'
|
||||
toc = true
|
||||
top = false
|
||||
+++
|
||||
|
||||
## Quick Start
|
||||
|
||||
One page summary of how to start a new AdiDoks project. [Quick Start →](../quick-start/)
|
||||
|
||||
## Go further
|
||||
|
||||
Contributing and Help.
|
||||
|
||||
## Contributing
|
||||
|
||||
Find out how to contribute to Doks. [Contributing →](../../contributing/how-to-contribute/)
|
||||
|
||||
## Help
|
||||
|
||||
Get help on Doks. [Help →](../../help/faq/)
|
||||
94
themes/adidoks/content/docs/getting-started/quick-start.md
Normal file
94
themes/adidoks/content/docs/getting-started/quick-start.md
Normal file
@ -0,0 +1,94 @@
|
||||
+++
|
||||
title = "Quick Start"
|
||||
description = "One page summary of how to start a new AdiDoks project."
|
||||
date = 2021-05-01T08:20:00+00:00
|
||||
updated = 2021-05-01T08:20:00+00:00
|
||||
draft = false
|
||||
weight = 20
|
||||
sort_by = "weight"
|
||||
template = "docs/page.html"
|
||||
|
||||
[extra]
|
||||
lead = "One page summary of how to start a new AdiDoks project."
|
||||
toc = true
|
||||
top = false
|
||||
+++
|
||||
|
||||
## Requirements
|
||||
|
||||
Before using the theme, you need to install the [Zola](https://www.getzola.org/documentation/getting-started/installation/) ≥ 0.15.0.
|
||||
|
||||
## Run the Theme Directly
|
||||
|
||||
```bash
|
||||
git clone https://github.com/aaranxu/adidoks.git
|
||||
cd adidoks
|
||||
zola serve
|
||||
```
|
||||
|
||||
Visit `http://127.0.0.1:1111/` in the browser.
|
||||
|
||||
## Installation
|
||||
|
||||
Just earlier we showed you how to run the theme directly. Now we start to
|
||||
install the theme in an existing site step by step.
|
||||
|
||||
### Step 1: Create a new zola site
|
||||
|
||||
```bash
|
||||
zola init mysite
|
||||
```
|
||||
|
||||
### Step 2: Install AdiDoks
|
||||
|
||||
Download this theme to your themes directory:
|
||||
|
||||
```bash
|
||||
cd mysite/themes
|
||||
git clone https://github.com/aaranxu/adidoks.git
|
||||
```
|
||||
|
||||
Or install as a submodule:
|
||||
|
||||
```bash
|
||||
cd mysite
|
||||
git init # if your project is a git repository already, ignore this command
|
||||
git submodule add https://github.com/aaranxu/adidoks.git themes/adidoks
|
||||
```
|
||||
|
||||
### Step 3: Configuration
|
||||
|
||||
Enable the theme in your `config.toml` in the site derectory:
|
||||
|
||||
```toml
|
||||
theme = "adidoks"
|
||||
```
|
||||
|
||||
Or copy the `config.toml.example` from the theme directory to your project's
|
||||
root directory:
|
||||
|
||||
```bash
|
||||
cp themes/adidoks/config.toml.example config.toml
|
||||
```
|
||||
|
||||
### Step 4: Add new content
|
||||
|
||||
You can copy the content from the theme directory to your project:
|
||||
|
||||
```bash
|
||||
cp -r themes/adidoks/content .
|
||||
```
|
||||
|
||||
You can modify or add new posts in the `content/blog`, `content/docs` or other
|
||||
content directories as needed.
|
||||
|
||||
### Step 5: Run the project
|
||||
|
||||
Just run `zola serve` in the root path of the project:
|
||||
|
||||
```bash
|
||||
zola serve
|
||||
```
|
||||
|
||||
AdiDoks will start the Zola development web server accessible by default at
|
||||
`http://127.0.0.1:1111`. Saved changes will live reload in the browser.
|
||||
10
themes/adidoks/content/docs/help/_index.md
Normal file
10
themes/adidoks/content/docs/help/_index.md
Normal file
@ -0,0 +1,10 @@
|
||||
+++
|
||||
title = "Help"
|
||||
description = "Get help on AdiDoks."
|
||||
date = 2025-05-01T19:00:00+00:00
|
||||
updated = 2021-05-01T19:00:00+00:00
|
||||
template = "docs/section.html"
|
||||
sort_by = "weight"
|
||||
weight = 5
|
||||
draft = false
|
||||
+++
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user