Commit Graph

16 Commits

Author SHA1 Message Date
Adam Leskis
8ace86f815 remove note referring to incrementing ports, since veilid-server does not do this anymore 2024-06-06 10:25:56 +01:00
Adam Leskis
5a1b72d218 update section title and add minor details
- briefly touch on the fact that headless nodes need to be internet facing or behind a firewall with port 5150 open
- update the title of the section to be "Network Considerations"
- add a link to the Developer Book for a more in-depth discussion
2024-05-22 22:22:52 +01:00
Adam Leskis
3dc015fe24 update details of "why" we need port 5150 and what veilid nodes expect 2024-05-07 11:41:17 +01:00
Adam Leskis
563b7c358a add in port access information to install docs
This refers to issue https://gitlab.com/veilid/veilid/-/issues/375
2024-04-22 14:52:49 +01:00
Salvatore Testa
0066b27d11
Add Homebrew instructions
The Homebrew maintainers just merged the formula for Veilid!
https://github.com/Homebrew/homebrew-core/pull/158399
2024-01-02 09:16:50 -08:00
TC
cf4d9148da Update INSTALL.md 2023-12-05 02:06:56 +00:00
zed tan
34b4419859 [#253] implement feedback for INSTALL.md
- re-add one missing `<br />`
- add `sudo` to `systemctl` commands
- removed quoted/admonished section for running veilid-server directly
- instead, made 'With systemd' and 'Without systemd' sub-sections, with
  instructions
- removed extraneous instructions to `usermod` to allow login for `veilid` user
2023-09-15 22:43:48 +02:00
zed tan
a3e3ab8ab5 [#253] add instructions to run veilid node
Added instructions to:

- Run a veilid node with systemd
- add instructions for getting veilid to start at boot
- Manually run a veilid node, because users may use platforms without
  systemd available.

Changes:

- Changed title to include run
- Added `systemctl start ...` instructions
- Added heavily caveated instructions to run veilid-server manually
2023-09-12 16:21:41 +02:00
zed tan
4b5bef83e2 [#253] clean up INSTALL.md
- Added `Install` section to group debian and rpm installs.
- Re-added `</br>`s -- they're used to break the `_Explanation:_` blocks
  to the next line. My personal preference is to _not_ use `</br>`s in
  docs, but i didn't want to change too many things here.
- Shortened titles `Add the repo to a Debian ...` and `... Fedora ...`
  to keep it super concise and decoupled from actual steps
- Some formatting best-practices
  - newlines between markdown blocks
  - indent code blocks that belong to bullet points to make sure
    that they are syntatically grouped (i.e. correct markdown 'DOM'
    hierarchy)
- sudo:
  - Removed `sudo` explanations. `apt/dnf/yum` will not run without, no
    need to explain.
  - added `sudo` to RPM instruction code blocks (just those two)
    for consistency, and also you can't run dnf/yum without root anyway.
- Made generic "Fedora based" instructions. Actually YUM/DNF-based,
  keeping it simple for now. Also name-dropped common distros for
  SEO/CTRL+F convenience
- Removed certain `Explanation` blocks for concision. Some are repeated,
  and some step titles are already self-explanatory
2023-09-12 16:19:32 +02:00
TC Johnson
84e3303cec
Cleaned up .md files syntax
Used the VScode markdownlint utility to make the syntax and
formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
Daniel Mulvey
d3e3379e2b update fedora instructions to use correct repo link 2023-08-27 14:31:10 -07:00
Chris Wall
a49c33827b Update file INSTALL.md 2023-08-24 17:41:35 +00:00
BanjoFox
29185985cb Fix typos 2023-08-18 21:33:58 +00:00
Banjo Fox
e9527faca4 Re-apply INSTALL.MD changes after fork sync. 2023-08-18 09:34:58 -04:00
Jason Ribble
b24b6e23f0 doc: fix typo
- cruicial -> crucial in INSTALL
2023-08-12 21:24:12 -07:00
TC Johnson
f4d71457da
Add docs and mod version bumping
Added and modified documentation for the contribution process.
Added the code of conduct file.
Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00