diff --git a/website/static/img/architecture.svg b/docs/architecture.svg similarity index 100% rename from website/static/img/architecture.svg rename to docs/architecture.svg diff --git a/website/static/img/architecture.svg.license b/docs/architecture.svg.license similarity index 100% rename from website/static/img/architecture.svg.license rename to docs/architecture.svg.license diff --git a/docs/contact.md b/docs/contact.mdx similarity index 60% rename from docs/contact.md rename to docs/contact.mdx index 15e2826c..3686f5e0 100644 --- a/docs/contact.md +++ b/docs/contact.mdx @@ -5,13 +5,15 @@ permalink: /contact # SPDX-License-Identifier: Apache-2.0 --- -import InlineIcon from '@site/src/components/InlineIcon'; - # Contact There are a couple of channels to reach us. Please try them from first to last. -## [ Community](https://discuss.cunicu.li) +import Github from './github_icon.svg'; +import Discourse from './discourse_icon.svg'; +import Fediverse from './fediverse_icon.svg'; + +## [ Community](https://discuss.cunicu.li) We are hosting our own forum, chat and wiki at [**discuss.cunicu.li**](https://discuss.cunicu.li).\ Feel free to say hi 👋, discuss cunīcu, ask questions or share ideas. @@ -19,13 +21,12 @@ Feel free to say hi 👋, discuss cunīcu, ask questions or share ideas. ## [🥷 Maintainer](https://github.com/orgs/cunicu/teams/maintainers) We are still mostly a one-man show driven by Steffen Vogel: - - GitHub: [stv0g](https://steffenvogel.de) - - Discourse: [stv0g](https://discuss.cunicu.li/u/stv0g) - - Fediverse: [@stv0g@chaos.social](https://chaos.social/@stv0g) + - GitHub: [stv0g](https://steffenvogel.de) + - Discourse: [stv0g](https://discuss.cunicu.li/u/stv0g) + - Fediverse: [@stv0g@chaos.social](https://chaos.social/@stv0g) - 🔗 Web: [steffenvogel.de](https://www.steffenvogel.de) - ✉️ E-Mail: post@steffenvogel.de ## [✉️ E-Mail](mailto:info@cunicu.li) -As a last resort, you can reach also reach us at **[info@cunicu.li](codeberg.org/cunicuu.li)**. -codeberg.org/cunicu +As a last resort, you can reach also reach us at **[info@cunicu.li](mailto:info@cunicu.li)**. diff --git a/docs/design.md b/docs/design.mdx similarity index 97% rename from docs/design.md rename to docs/design.mdx index 9ffaac43..2d96f39c 100644 --- a/docs/design.md +++ b/docs/design.mdx @@ -8,50 +8,38 @@ sidebar_position: 20 ## Architecture -![](/img/architecture.svg) +import Architecture from './architecture.svg'; + + ## Objectives - Encrypt all signaling messages - - Plug-able signaling backends: - gRPC - - Support [Trickle ICE][rfc8838] - - Support [ICE restart][rfc8445-ice-restart] - - Support [ICE-TCP][rfc6544] - - Encrypt exchanged ICE offers with WireGuard keys - - Seamless switch between ICE candidates and relays - - Zero configuration - Alleviate users of exchanging endpoint IPs & ports - - Enables direct communication of WireGuard peers behind NAT / UDP-blocking firewalls - - Single-binary, zero dependency installation - Bundled ICE agent & [WireGuard user-space daemon][wireguard-go] - Portability - - Support for user and kernel-space WireGuard implementations - - Zero performance impact - Kernel-side filtering / redirection of WireGuard traffic - Fallback to user-space proxying only if no Kernel features are available - - Minimized attack surface - Drop privileges after initial configuration - - Compatible with existing WireGuard configuration utilities like: - [NetworkManager][network-manager] - [systemd-networkd][systemd-networkd] - [wg-quick][wg-quick] - [Kilo][kilo] - [drago][drago] - - Monitoring for new WireGuard interfaces and peers - Inotify for new UAPI sockets in /var/run/wireguard - Netlink subscription for link updates (patch is pending) diff --git a/website/static/img/proxy.svg b/docs/dev/proxy.svg similarity index 100% rename from website/static/img/proxy.svg rename to docs/dev/proxy.svg diff --git a/website/static/img/proxy.svg.license b/docs/dev/proxy.svg.license similarity index 100% rename from website/static/img/proxy.svg.license rename to docs/dev/proxy.svg.license diff --git a/docs/dev/proxying.md b/docs/dev/proxying.mdx similarity index 98% rename from docs/dev/proxying.md rename to docs/dev/proxying.mdx index 7b230fc5..41dd3267 100644 --- a/docs/dev/proxying.md +++ b/docs/dev/proxying.mdx @@ -72,7 +72,9 @@ This variant only works for the compiled-in version of wireguard-go in cunīcu. ## Flowchart -![](/img/proxy.svg) +import Proxy from './proxy.svg'; + + [nftables]: https://www.netfilter.org/projects/nftables/manpage.html diff --git a/website/static/img/discourse_icon.svg b/docs/discourse_icon.svg similarity index 100% rename from website/static/img/discourse_icon.svg rename to docs/discourse_icon.svg diff --git a/website/static/img/fediverse_logo_proposal.svg b/docs/fediverse_icon.svg similarity index 100% rename from website/static/img/fediverse_logo_proposal.svg rename to docs/fediverse_icon.svg diff --git a/website/static/img/flag_of_europe.svg b/docs/flag_of_europe.svg similarity index 100% rename from website/static/img/flag_of_europe.svg rename to docs/flag_of_europe.svg diff --git a/website/static/img/flag_of_europe.svg.license b/docs/flag_of_europe.svg.license similarity index 100% rename from website/static/img/flag_of_europe.svg.license rename to docs/flag_of_europe.svg.license diff --git a/docs/funding.md b/docs/funding.mdx similarity index 53% rename from docs/funding.md rename to docs/funding.mdx index 2f685005..21ece10b 100644 --- a/docs/funding.md +++ b/docs/funding.mdx @@ -9,4 +9,6 @@ sidebar_position: 98 The project has been initiated by Steffen Vogel while working at the [Institute for Automation of Complex Power Systems (ACS)](https://www.acs.eonerc.rwth-aachen.de) of [RWTH Aachen University](https://www.rwth-aachen.de). -European Flag The development of cunīcu has been supported by the ERIGrid 2.0 project of the H2020 Programme under Grant Agreement No. 870620 +import FlagOfEurope from './flag_of_europe.svg'; + + The development of cunīcu has been supported by the ERIGrid 2.0 project of the H2020 Programme under Grant Agreement No. 870620 diff --git a/website/static/img/github_mark.svg b/docs/github_icon.svg similarity index 100% rename from website/static/img/github_mark.svg rename to docs/github_icon.svg diff --git a/website/static/img/github_mark_white.svg b/docs/github_icon_white.svg similarity index 100% rename from website/static/img/github_mark_white.svg rename to docs/github_icon_white.svg diff --git a/docs/index.md b/docs/index.mdx similarity index 97% rename from docs/index.md rename to docs/index.mdx index 35bb4c4f..8b2bbce4 100644 --- a/docs/index.md +++ b/docs/index.mdx @@ -6,8 +6,10 @@ hide_title: true # SPDX-License-Identifier: Apache-2.0 --- +import CunicuLogo from '../static/img/cunicu_logo.svg'; +

- cunīcu logo + [![goreportcard](https://goreportcard.com/badge/codeberg.org/cunicu/cunicu?style=flat-square)](https://goreportcard.com/report/codeberg.org/cunicu/cunicu) [![Go Reference](https://pkg.go.dev/badge/codeberg.org/cunicu/cunicu.svg)](https://pkg.go.dev/codeberg.org/cunicu/cunicu) diff --git a/website/static/img/cunicu_sticker.svg b/website/blog/2022-09-15-welcome/cunicu_sticker.svg similarity index 100% rename from website/static/img/cunicu_sticker.svg rename to website/blog/2022-09-15-welcome/cunicu_sticker.svg diff --git a/website/static/img/cunicu_sticker.svg.license b/website/blog/2022-09-15-welcome/cunicu_sticker.svg.license similarity index 100% rename from website/static/img/cunicu_sticker.svg.license rename to website/blog/2022-09-15-welcome/cunicu_sticker.svg.license diff --git a/website/blog/2022-09-15-welcome/index.md b/website/blog/2022-09-15-welcome/index.mdx similarity index 92% rename from website/blog/2022-09-15-welcome/index.md rename to website/blog/2022-09-15-welcome/index.mdx index bbd59cf7..7b38db5a 100644 --- a/website/blog/2022-09-15-welcome/index.md +++ b/website/blog/2022-09-15-welcome/index.mdx @@ -19,6 +19,8 @@ We are planning to publish the first official release within the next 4-10 weeks The release pipeline, packaging and self-update feature and more has already been implemented. We just need to finish the last features and do quite some more testing. +{/* truncate */} + ### Website, Docs and Twitter The project has now its dedicated [website](https://cunicu.li), [Codeberg organization](https://codeberg.org/cunicu) and Twitter handle ([@cunicuVPN](https://twitter.com/cunicuVPN)). @@ -29,14 +31,15 @@ The project name _cunīcu_ \[kʊˈniːkʊ\] is derived from the [latin noun cun This also gave us the opportunity to redesign the logo which you find further down in the sticker design. - ### Stickers We have stickers! Just [reach out](/docs/contact) and I will send you some or talk to me at some of the upcoming conferences. +import Sticker from './cunicu_sticker.svg'; +

- The sticker design +
The sticker design
diff --git a/website/blog/2024-06-12-community/index.md b/website/blog/2024-06-12-community/index.md index 67fea517..2d4f06bb 100644 --- a/website/blog/2024-06-12-community/index.md +++ b/website/blog/2024-06-12-community/index.md @@ -22,6 +22,8 @@ Whether you're a seasoned contributor or a newcomer, everyone is welcome. Just h Visit our Discourse at: **[discuss.cunicu.li](https://discuss.cunicu.li)**. ::: + + ## Access and Participation For those who wish to browse and read content, our community space offers read-only access without the need for an account. diff --git a/website/src/components/InlineIcon/index.js b/website/src/components/InlineIcon/index.js deleted file mode 100644 index 829636e8..00000000 --- a/website/src/components/InlineIcon/index.js +++ /dev/null @@ -1,11 +0,0 @@ -// SPDX-FileCopyrightText: 2023-2025 Steffen Vogel -// SPDX-License-Identifier: Apache-2.0 - -import React from 'react'; -import styles from './styles.module.css'; - -export default function Icon({src}) { - return ( - - ); -} diff --git a/website/src/components/InlineIcon/styles.module.css b/website/src/components/InlineIcon/styles.module.css deleted file mode 100644 index 27861a49..00000000 --- a/website/src/components/InlineIcon/styles.module.css +++ /dev/null @@ -1,9 +0,0 @@ -/* -SPDX-FileCopyrightText: 2023-2025 Steffen Vogel -SPDX-License-Identifier: Apache-2.0 -*/ - -.inlineicon { - height: 1em; - margin-bottom: -2px; -} diff --git a/website/src/css/custom.css b/website/src/css/custom.css index da0ec3bb..ffcd3617 100644 --- a/website/src/css/custom.css +++ b/website/src/css/custom.css @@ -43,8 +43,14 @@ opacity: 0.6; } +.inline-icon { + height: 1em; + width: 1em; + margin-bottom: -2px; +} + .header-github-link:before { - background: url("/img/github_mark.svg"); + background: url("/img/github_icon.svg"); background-size: contain; content: ""; display: flex; @@ -53,7 +59,7 @@ } [data-theme='dark'] .header-github-link::before { - background: url("/img/github_mark_white.svg"); + background: url("/img/github_icon_white.svg"); } diff --git a/website/src/pages/index.js b/website/src/pages/index.js index f7280998..dff24032 100644 --- a/website/src/pages/index.js +++ b/website/src/pages/index.js @@ -11,6 +11,8 @@ import BrowserOnly from '@docusaurus/BrowserOnly'; import MeshAnimation from '../components/MeshAnimation'; import styles from './index.module.css'; +import CunicuLogoDark from '../../static/img/cunicu_logo_dark.svg'; + function HomepageHeader() { const {siteConfig} = useDocusaurusContext(); return ( @@ -21,7 +23,7 @@ function HomepageHeader() { }}
- {siteConfig.title +
\ No newline at end of file diff --git a/website/static/img/github_icon_white.svg b/website/static/img/github_icon_white.svg new file mode 100644 index 00000000..d5e64918 --- /dev/null +++ b/website/static/img/github_icon_white.svg @@ -0,0 +1 @@ + \ No newline at end of file