mirror of
https://gitlab.com/veilid/veilid-dot-com.git
synced 2025-04-19 06:55:48 -04:00
Starting to fill out the server & cli install instructions more
This commit is contained in:
Alice Rhodes
parent
b6722cdef3
commit
0c672e1120
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Accessibility Guidance
|
||||
description: An introduction to accessibility concepts
|
||||
weight: 4
|
||||
weight: 7
|
||||
layout: subpage
|
||||
---
|
||||
|
||||
|
||||
@ -24,12 +24,6 @@ The main repository is located at https://gitlab.com/veilid/veilid and includes
|
||||
- `veilid-flutter` - Veilid bindings for Flutter/Dart. Comes with an example program: https://crates.io/crates/veilid-flutter
|
||||
- Also `veilid-server` and `veilid-cli` source are also in this repo for building headless nodes
|
||||
|
||||
|
||||
### Packages
|
||||
|
||||
If you want to install `veilid-server` and `veilid-cli` from package repositories,
|
||||
please refer to our [instructions](https://gitlab.com/veilid/veilid/-/blob/main/INSTALL.md).
|
||||
|
||||
### VeilidChat
|
||||
|
||||
The code for VeilidChat will be available at https://gitlab.com/veilid/veilidchat once we're recovered from DefCon.
|
||||
|
||||
@ -1,62 +1,64 @@
|
||||
---
|
||||
title: Accessibility Guidance
|
||||
description: An introduction to accessibility concepts
|
||||
weight: 4
|
||||
title: Debian Install
|
||||
description: How to install `veilid-server` and `veilid-cli` on Debian based systems
|
||||
weight: 3
|
||||
layout: subpage
|
||||
---
|
||||
|
||||
### Step 1
|
||||
|
||||
### General Accessibility Concepts
|
||||
Get the keys for package repo
|
||||
|
||||
For the scope of this document, we are referring to the accessibility of websites, documents, and applications.
|
||||
<div class="code-snippet">
|
||||
<input aria-label="Get Keys" type="text" readonly value="wget -O- https://packages.veilid.net/gpg/veilid-packages-key.public | sudo gpg --dearmor -o /usr/share/keyrings/veilid-packages-keyring.gpg">
|
||||
<button class="btn btn-secondary"><span>Copy</span></button>
|
||||
</div>
|
||||
|
||||
### Types of Accessibility Challenges
|
||||
### Step 2
|
||||
|
||||
Here is a partial list of capabilities to keep in mind when designing:
|
||||
Add the repo to apt
|
||||
|
||||
**Fine Motor Control** – The dexterity of one's eyes, hands, and fingers for the ability to examine and manipulate objects. In practical terms, is it easy for someone using a touch screen to easily click interactive elements and can folks with fine motor control issues manage to interact with those elements was well.
|
||||
<div class="code-snippet">
|
||||
<input aria-label="Add Keys" type="text" readonly value='echo "deb [arch=amd64 signed-by=/usr/share/keyrings/veilid-packages-keyring.gpg] https://packages.veilid.net/apt stable main" > /etc/apt/sources.list.d/veilid.list'>
|
||||
<button class="btn btn-secondary"><span>Copy</span></button>
|
||||
</div>
|
||||
|
||||
**Sightedness** – Levels of blindness, near sightedness, and far sightedness. Low-vision users tend to need high color contrast and larger sized text and elements.
|
||||
### Step 3
|
||||
|
||||
**Color Vision** – Color blindness changes how people perceive colors which can reduce color contrast and make differentiating color coded items difficult.
|
||||
Update your system
|
||||
|
||||
**Cognitive Capabilities** – Memory, train of thought, following instructions, and judgment are cognitive capabilities that most folks take for granted. Various disabilities can affect these as well as situational conditions such as being tired from working late.
|
||||
<div class="code-snippet">
|
||||
<input aria-label="Run Updates" type="text" readonly value="apt update">
|
||||
<button class="btn btn-secondary"><span>Copy</span></button>
|
||||
</div>
|
||||
|
||||
**Hearing** – Hearing difficulties can make audio cues or videos less effective.
|
||||
### Step 4
|
||||
|
||||
### Accessibility Guidelines
|
||||
Install `veilid-server` and `veilid-cli`
|
||||
|
||||
Here is a partial list of general accessibility goals you should strive for:
|
||||
<div class="code-snippet">
|
||||
<input aria-label="Install the headless and command line utilities" type="text" readonly value="apt install veilid-server veilid-cli">
|
||||
<button class="btn btn-secondary"><span>Copy</span></button>
|
||||
</div>
|
||||
|
||||
#### Structure
|
||||
### Step 5
|
||||
|
||||
- Headers are marked denoted at headers in the mark-up or code
|
||||
- Sections of a page or screen are visually distinct and easy to identify
|
||||
Start `veilid-server.service` manually
|
||||
|
||||
#### Navigation
|
||||
<div class="code-snippet">
|
||||
<input aria-label="Install the headless and command line utilities" type="text" readonly value="sudo systemctl start veilid-server.service">
|
||||
<button class="btn btn-secondary"><span>Copy</span></button>
|
||||
</div>
|
||||
|
||||
- Easy to figure out current location
|
||||
- Easy to figure out where you can go
|
||||
- Consistent navigation structures and styling
|
||||
### Step 6
|
||||
|
||||
#### Interactions
|
||||
Set up `veilid-server.service` to start at boot
|
||||
|
||||
- Clickable items are styled consistently as clickable
|
||||
- Clickable items have a generous hit-box size
|
||||
- UI elements can be easily manipulated with assistive technology
|
||||
<div class="code-snippet">
|
||||
<input aria-label="Install the headless and command line utilities" type="text" readonly value="sudo systemctl enable --now veilid-server.service">
|
||||
<button class="btn btn-secondary"><span>Copy</span></button>
|
||||
</div>
|
||||
|
||||
#### Typography
|
||||
|
||||
- Adjustable text size
|
||||
- Adjusting the text size does not breaking the layout or usability
|
||||
- Text customization options such as changing fonts
|
||||
|
||||
#### Colors
|
||||
|
||||
- Good color contrast for text to be readable
|
||||
- Use a secondary indicator (shape, size, pattern, etc) rather than color alone
|
||||
|
||||
#### Video
|
||||
|
||||
- For the audio in videos, provide subtitles of the dialog and sounds
|
||||
- A transcript of all the content conveyed in the video helps a wide audiences
|
||||
@ -1,62 +1,18 @@
|
||||
---
|
||||
title: Debian Install
|
||||
description: How to install `veilid-server` and `veilid-cli` on Debian based systems
|
||||
weight: 3
|
||||
title: Fedora Install
|
||||
description: How to install `veilid-server` and `veilid-cli` on Fedora based systems
|
||||
weight: 4
|
||||
layout: subpage
|
||||
---
|
||||
|
||||
<h3>Fedora Based Systems</h3>
|
||||
|
||||
### General Accessibility Concepts
|
||||
<div class="code-snippet">
|
||||
<input aria-label="Add repo" type="text" readonly value="yum-config-manager --add-repo https://packages.veilid.net/rpm/veilid-rpm-repo.repo">
|
||||
<button class="btn btn-secondary"><span>Copy</span></button>
|
||||
</div>
|
||||
|
||||
For the scope of this document, we are referring to the accessibility of websites, documents, and applications.
|
||||
|
||||
### Types of Accessibility Challenges
|
||||
|
||||
Here is a partial list of capabilities to keep in mind when designing:
|
||||
|
||||
**Fine Motor Control** – The dexterity of one's eyes, hands, and fingers for the ability to examine and manipulate objects. In practical terms, is it easy for someone using a touch screen to easily click interactive elements and can folks with fine motor control issues manage to interact with those elements was well.
|
||||
|
||||
**Sightedness** – Levels of blindness, near sightedness, and far sightedness. Low-vision users tend to need high color contrast and larger sized text and elements.
|
||||
|
||||
**Color Vision** – Color blindness changes how people perceive colors which can reduce color contrast and make differentiating color coded items difficult.
|
||||
|
||||
**Cognitive Capabilities** – Memory, train of thought, following instructions, and judgment are cognitive capabilities that most folks take for granted. Various disabilities can affect these as well as situational conditions such as being tired from working late.
|
||||
|
||||
**Hearing** – Hearing difficulties can make audio cues or videos less effective.
|
||||
|
||||
### Accessibility Guidelines
|
||||
|
||||
Here is a partial list of general accessibility goals you should strive for:
|
||||
|
||||
#### Structure
|
||||
|
||||
- Headers are marked denoted at headers in the mark-up or code
|
||||
- Sections of a page or screen are visually distinct and easy to identify
|
||||
|
||||
#### Navigation
|
||||
|
||||
- Easy to figure out current location
|
||||
- Easy to figure out where you can go
|
||||
- Consistent navigation structures and styling
|
||||
|
||||
#### Interactions
|
||||
|
||||
- Clickable items are styled consistently as clickable
|
||||
- Clickable items have a generous hit-box size
|
||||
- UI elements can be easily manipulated with assistive technology
|
||||
|
||||
#### Typography
|
||||
|
||||
- Adjustable text size
|
||||
- Adjusting the text size does not breaking the layout or usability
|
||||
- Text customization options such as changing fonts
|
||||
|
||||
#### Colors
|
||||
|
||||
- Good color contrast for text to be readable
|
||||
- Use a secondary indicator (shape, size, pattern, etc) rather than color alone
|
||||
|
||||
#### Video
|
||||
|
||||
- For the audio in videos, provide subtitles of the dialog and sounds
|
||||
- A transcript of all the content conveyed in the video helps a wide audiences
|
||||
<div class="code-snippet">
|
||||
<input aria-label="Install the headless and command line utilities" type="text" readonly value="dnf install veilid-server veilid-cli">
|
||||
<button class="btn btn-secondary"><span>Copy</span></button>
|
||||
</div>
|
||||
@ -1,47 +1,12 @@
|
||||
---
|
||||
title: Package Repositories
|
||||
description: Veilid has Rust, Python, Debian, and Fedora packages available.
|
||||
weight: 3
|
||||
weight: 6
|
||||
layout: subpage
|
||||
---
|
||||
|
||||
To run a "headless" Veilid node, you can install `veilid-server` and `veilid-cli` from repositories.
|
||||
|
||||
<h3>Debian Based Systems</h3>
|
||||
|
||||
<div class="code-snippet">
|
||||
<input aria-label="Get Keys" type="text" readonly value="wget -O- https://packages.veilid.net/gpg/veilid-packages-key.public | sudo gpg --dearmor -o /usr/share/keyrings/veilid-packages-keyring.gpg">
|
||||
<button class="btn btn-secondary"><span>Copy</span></button>
|
||||
</div>
|
||||
|
||||
<p>Note: The key's fingerprint is <code>516C76D1E372C5C96EE54E22AE0E059BC64CD052</code></p>
|
||||
|
||||
<div class="code-snippet">
|
||||
<input aria-label="Add Keys" type="text" readonly value='echo "deb [arch=amd64 signed-by=/usr/share/keyrings/veilid-packages-keyring.gpg] https://packages.veilid.net/apt stable main" > /etc/apt/sources.list.d/veilid.list'>
|
||||
<button class="btn btn-secondary"><span>Copy</span></button>
|
||||
</div>
|
||||
|
||||
<div class="code-snippet">
|
||||
<input aria-label="Run Updates" type="text" readonly value="apt update">
|
||||
<button class="btn btn-secondary"><span>Copy</span></button>
|
||||
</div>
|
||||
|
||||
<div class="code-snippet">
|
||||
<input aria-label="Install the headless and command line utilities" type="text" readonly value="apt install veilid-server veilid-cli">
|
||||
<button class="btn btn-secondary"><span>Copy</span></button>
|
||||
</div>
|
||||
|
||||
|
||||
<h3>Fedora Based Systems</h3>
|
||||
|
||||
<div class="code-snippet">
|
||||
<input aria-label="Add repo" type="text" readonly value="yum-config-manager --add-repo https://packages.veilid.net/rpm/veilid-rpm-repo.repo">
|
||||
<button class="btn btn-secondary"><span>Copy</span></button>
|
||||
</div>
|
||||
<div class="code-snippet">
|
||||
<input aria-label="Install the headless and command line utilities" type="text" readonly value="dnf install veilid-server veilid-cli">
|
||||
<button class="btn btn-secondary"><span>Copy</span></button>
|
||||
</div>
|
||||
|
||||
<h3>PyPi</h3>
|
||||
<p><a href="https://pypi.org/project/veilid/">https://pypi.org/project/veilid/</a></p>
|
||||
- [Debian](/docs/debian-install/)
|
||||
- [Fedora](http://localhost:8000/docs/fedora-install/)
|
||||
- [PyPi](https://pypi.org/project/veilid/)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user