Skip to content

Commit

Permalink
Small fixes for README and associated documents. (#1198)
Browse files Browse the repository at this point in the history
Not much to add:
 - Three small improvements for the README file
 - Headings at avahi.md were inconsistent
  • Loading branch information
ancorgs authored May 13, 2024
2 parents fb4250a + 4f98d9f commit 3d66032
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 10 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,14 @@ Agama is a new Linux installer born in the core of the YaST team. It is designed

## Why a New Installer

This new project follows two main motivations: to overcome some of the limitations of YaST and to serve as installer for new projects like SUSE ALP (Adaptable Linux Platform).
This new project follows two main motivations: to overcome some of the limitations of YaST and to serve as installer for new projects, like those based on SUSE Linux Framework One.

YaST is a mature installer and control center for SUSE and openSUSE operating systems. With more than 20 years behind it, YaST is a competent and flexible installer able to cover uncountable use cases. But time goes by, and the good old YaST is starting to show its age in some aspects:

* The architecture of YaST is complex and its code-base has too much technical debt.
* Designing and building rich and modern user interfaces is a real challenge.
* Sharing logic with other tools like Salt or Ansible is very difficult.
* Some in-house solutions like libyui makes more difficult to contribute to the project.
* Some in-house solutions like [libyui](https://github.com/libyui/libyui) make more difficult to contribute to the project.

## Running Agama

Expand Down Expand Up @@ -73,7 +73,7 @@ mDNS (sometimes called Avahi, Zeroconf, Bonjour) for hostname resolution. Theref
> hostname resolutions and point you to a wrong Agama instance which could for example steal your
> root password!
If you have troubles or you want to know more about this feature, check our [Avahi/mDNS] (./doc/avahi.md) documentation.
If you have troubles or you want to know more about this feature, check our [Avahi/mDNS](./doc/avahi.md) documentation.

## Other Resources

Expand Down
13 changes: 6 additions & 7 deletions doc/avahi.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#### Avahi/mDNS
# Avahi/mDNS

Agama's Live ISO is configured to use mDNS (sometimes called Avahi, Zeroconf, Bonjour) for hostname
resolution. The reason is that it might be quite difficult to find out which URL should be used for
Expand All @@ -12,7 +12,7 @@ This document explains how this feature works and offers a few hints for fix pot
> hostname resolutions and point you to a wrong Agama instance which could for example steal your
> root password!
##### Firewall Configuration
## Firewall Configuration

If you cannot connect to a server using the `.local` domain then maybe the
firewall is blocking the traffic. Then you need to enable the mDNS traffic using
Expand All @@ -25,7 +25,7 @@ firewall-cmd --zone=public --add-service=mdns
firewall-cmd --permanent --zone=public --add-service=mdns
```

##### Using mDNS
## Using mDNS

The Live ISO by default uses the `agama.local` hostname. To connect to the
running instance simply type `https://agama.local` in your browser. In most
Expand Down Expand Up @@ -62,13 +62,13 @@ ping agama.local
ssh root@agama.local
```

##### Fallback
## Fallback

The mDNS approach is just an addition, one more possibility how to connect to
the machine. If it does not work for you then you can always use the old good
classic IP address approach.

##### Service Advertising
## Service Advertising

The Agama Live ISO also uses Avahi service advertising. With this you can easily
search for all running Agama instances in the local network:
Expand All @@ -79,12 +79,11 @@ avahi-browse -t -r _agama._sub._https._tcp

The command will print the found servers and their hostnames and IP addresses.

##### Notes
## Notes

- mDNS works only in the same local network, it does not work over internet
or separate network segments.
- mDNS might not be supported in all systems or it might be blocked by firewall.
- On mobile phones with Android OS mDNS is supported since Android version 12.
(but this might be vendor dependent...).


0 comments on commit 3d66032

Please sign in to comment.