Joachim Wiberg and Tobias Waldekranz
b480cd76f1
Fix #64 : initial Developer's Guide
...
Signed-off-by: Joachim Wiberg <troglobit@gmail.com >
2023-08-16 13:52:04 +02:00
Joachim Wiberg and Tobias Waldekranz
93db790de6
Untabify
...
Signed-off-by: Joachim Wiberg <troglobit@gmail.com >
2023-08-16 13:52:04 +02:00
Joachim Wiberg and Tobias Waldekranz
d2ccb32871
New logo and split of README in multiple pages
...
This is a cleanup and reorganization of the Infix documentation.
Starting with a simplification of the top-level README, splitting
it up into several pages.
Also, fixes #100 by updating the documentation on Qemu.
Signed-off-by: Joachim Wiberg <troglobit@gmail.com >
2023-08-16 13:52:04 +02:00
Joachim Wiberg and Tobias Waldekranz
9766bbbed5
doc/cli: update all the topics to match the refreshed CLI functions
...
Also, add a new `quick.md` that pops up when the user types `help`.
Very quick intro to get started. Useful when we add a factory-default
motd: "Welcome to the CLI, type 'help' for a quick overview."
Signed-off-by: Joachim Wiberg <troglobit@gmail.com >
2023-08-08 16:35:18 +02:00
Joachim Wiberg and Tobias Waldekranz
d913ce00e6
doc/cli: relocate and extend CLI docs with intro and keybindings
...
This is not just for online viewing, these markdown documents are also
made available in the CLI itself from admin-exec as:
help [introduction | keybindings | tutorial]
With this commit we also add lowdown and the real less application to
be the Infix help system.
Signed-off-by: Joachim Wiberg <troglobit@gmail.com >
2023-08-08 16:35:18 +02:00
Joachim Wiberg
6d536e1b3f
Further clarify how to use containers in Infix
...
Signed-off-by: Joachim Wiberg <troglobit@gmail.com >
2023-06-28 08:57:42 +02:00
Joachim Wiberg
15843f4325
doc/container.md: add Real Example and update Hybrid Mode
...
Add a real example where we create a writable layer for container based
on a simple image.
To be able to properly start/stop and monitor containers using Finit, we
need to add the options `--systemd=false` and `--conmon-pidfile=...`.
Signed-off-by: Joachim Wiberg <troglobit@gmail.com >
2023-06-27 11:55:40 +02:00
Joachim Wiberg
a8f14b949c
doc/container.md: use correct interface in cni host interface
...
We usually put the vethNb interfaces in the bridge and the vethNa end in
the appliance/container.
Signed-off-by: Joachim Wiberg <troglobit@gmail.com >
2023-06-25 22:47:06 +02:00
Joachim Wiberg
44983a4bd5
doc/cli.md: add diff to veth and bridge sections
...
Signed-off-by: Joachim Wiberg <troglobit@gmail.com >
2023-06-25 15:27:48 +02:00
Joachim Wiberg
01455a08f8
doc/container.md: use unused host port 222 for container port 22
...
Signed-off-by: Joachim Wiberg <troglobit@gmail.com >
2023-06-25 13:05:54 +02:00
Joachim Wiberg
cc1845d62b
doc/container.md: add section on debugging
...
Signed-off-by: Joachim Wiberg <troglobit@gmail.com >
2023-06-25 12:53:37 +02:00
Joachim Wiberg
43c68de6f1
doc/container.md: update Multiple Networks and Hybrid Mode example
...
Signed-off-by: Joachim Wiberg <troglobit@gmail.com >
2023-06-25 12:06:45 +02:00
Joachim Wiberg
eed5c2f206
doc/cli.md: update with a toc and help on veth pairs and bridging
...
Signed-off-by: Joachim Wiberg <troglobit@gmail.com >
2023-06-25 11:56:42 +02:00
Joachim Wiberg
593a0626d1
doc: always lead with an example, put caveats last
...
Signed-off-by: Joachim Wiberg <troglobit@gmail.com >
2023-06-24 18:42:42 +02:00
Jon-Olov Vatn and Joachim Wiberg
aa372c247e
Fixing typos is Infix discovery doc.
...
Ready for review.
Note for future: Add picture on Infix as Network Infrastructure
equipment in Windows Explorer (SSDP section)
2023-06-16 16:21:14 +02:00
Jon-Olov Vatn and Joachim Wiberg
ede1f59479
Minor changes to Infix discovery doc
2023-06-16 16:21:14 +02:00
Jon-Olov Vatn and Joachim Wiberg
14712fdc91
Add info on Infix discovery services and possibilities
2023-06-16 16:21:14 +02:00
Tobias Waldekranz and Joachim Wiberg
77f9ca8e2a
doc/testing: Add an overview of the test system
2023-06-14 17:40:16 +02:00
Joachim Wiberg
646364a6e0
doc: update README and add doc/cli.md
...
Signed-off-by: Joachim Wiberg <troglobit@gmail.com >
2023-06-02 15:38:40 +02:00
Joachim Wiberg and Tobias Waldekranz
d8b24e16de
doc: new document, Containers in Infix (with podman & CNI)
...
Signed-off-by: Joachim Wiberg <troglobit@gmail.com >
2023-05-21 20:39:12 +02:00
Joachim Wiberg and Tobias Waldekranz
5d7e6bd693
Rename amd64 -> x86_64 and native -> classic
...
A long standing internal debate comes to its logical conclusion. Arch
naming should follow GCC. The "native /etc" has also found a better
name: classic!
README and GitHub action has been updated accordingly.
Signed-off-by: Joachim Wiberg <troglobit@gmail.com >
2023-04-27 09:59:35 +02:00
Joachim Wiberg
81c9398a19
doc: project goals and founding ideas
...
Signed-off-by: Joachim Wiberg <troglobit@gmail.com >
2023-03-27 14:13:25 +02:00
Joachim Wiberg
eed61988d1
doc: RESTCONF adventures, lab notes
...
Signed-off-by: Joachim Wiberg <troglobit@gmail.com >
2023-03-27 14:11:10 +02:00
Tobias Waldekranz
77d94e0ffd
doc: Expand boot procedure documentation
...
Provide more details on the boot procedure, different image types
used, how to configure the bootloader, and how to perform system
upgrades.
2023-03-13 23:20:01 +01:00
Tobias Waldekranz
d1607cc2f3
doc: Document boot process and image formats
2023-03-13 09:55:16 +01:00
Joachim Wiberg
b05f51f673
Guidelines for how to contribute to the project
...
Signed-off-by: Joachim Wiberg <troglobit@gmail.com >
2023-01-11 18:07:12 +01:00
Joachim Wiberg
8d9bd8ec09
Roll out final product branding
...
Change all inf/IX or Inf/IX to plain Infix after steering group meeting.
Signed-off-by: Joachim Wiberg <troglobit@gmail.com >
2022-12-05 21:09:05 +01:00
Joachim Wiberg
179024b091
doc: add raw svg logos made using Inkscape
...
Signed-off-by: Joachim Wiberg <troglobit@gmail.com >
2022-11-26 17:09:43 +01:00
Joachim Wiberg
a83542df8d
Change to logo variant more suitable for dark mode
...
Signed-off-by: Joachim Wiberg <troglobit@gmail.com >
2022-11-26 17:09:15 +01:00
Joachim Wiberg
1b426edc2a
New logo
...
Signed-off-by: Joachim Wiberg <troglobit@gmail.com >
2022-11-26 17:08:59 +01:00