Skip to content

Commit

Permalink
chore: update screenshots (#1398)
Browse files Browse the repository at this point in the history
Update the screenshots that are shown in the README.
  • Loading branch information
imobachgs authored Jun 27, 2024
2 parents c56bd4a + 6845bb3 commit c6c5462
Show file tree
Hide file tree
Showing 8 changed files with 44 additions and 38 deletions.
82 changes: 44 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,54 +9,58 @@
[![Coverage Status](https://coveralls.io/repos/github/openSUSE/agama/badge.svg?branch=master)](https://coveralls.io/github/openSUSE/agama?branch=master)
[![Translation Status](https://l10n.opensuse.org/widgets/agama/-/agama-web/svg-badge.svg)](https://l10n.opensuse.org/engage/agama/)

Agama is a new Linux installer born in the core of the YaST team. It is designed to offer re-usability, integration with third party tools and the possibility of building advanced user interfaces over it.
Agama is a new Linux installer born in the core of the YaST team. It is designed to offer
re-usability, integration with third party tools and the possibility of building advanced user
interfaces over it.

|||
|-|-|
| | |
| -------------------------------------------------------------------- | --------------------------------------------------------------- |
| ![Product selection](./doc/images/screenshots/product-selection.png) | ![Installation overview](./doc/images/screenshots/overview.png) |

<details>
<summary>Click to show/hide more screenshots</summary>

---

| | |
| ------------------------------------------------------------ | -------------------------------------------------------------- |
| ![Software page](./doc/images/screenshots/software-page.png) | ![Storage settings](./doc/images/screenshots/storage-page.png) |

|||
|-|-|
| ![Users page](./doc/images/screenshots/users-page.png) | ![Storage settings](./doc/images/screenshots/storage-page.png) |

|||
|-|-|
| | |
| ------------------------------------------------------ | --------------------------------------------------------------- |
| ![Installing](./doc/images/screenshots/installing.png) | ![Installation finished](./doc/images/screenshots/finished.png) |

*Note for developers: For updating the screenshots see the
[integration test documentation](playwright/README.md#updating-the-screenshots).*
_Note for developers: For updating the screenshots see the
[integration test documentation](playwright/README.md#updating-the-screenshots)._

</details>

## 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 those based on SUSE Linux Framework One.
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:
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](https://github.com/libyui/libyui) make more difficult to contribute to the project.
- 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](https://github.com/libyui/libyui) make more difficult to
contribute to the project.

## Running Agama

The easiest way to give Agama a try is to grab a live ISO image and boot it in a virtual
machine. This is also the recommended way if you only want to play and see it in action. If you want
to have a closer look, then clone and configure the project as explained in the next section.
The easiest way to give Agama a try is to grab a live ISO image and boot it in a virtual machine.
This is also the recommended way if you only want to play and see it in action. If you want to have
a closer look, then clone and configure the project as explained in the next section.

You can download the ISO from the [openSUSE Build
Service](https://download.opensuse.org/repositories/systemsmanagement:/Agama:/Devel/images/iso/).
You can download the ISO from the
[openSUSE Build Service](https://download.opensuse.org/repositories/systemsmanagement:/Agama:/Devel/images/iso/).

> [!NOTE]
> Make sure to download the correct ISO file according to your system architecture (eg. you would
> need to choose a file including `x86_64` if you use an Intel or AMD 64-bit processor).
> [!NOTE] Make sure to download the correct ISO file according to your system architecture (eg. you
> would need to choose a file including `x86_64` if you use an Intel or AMD 64-bit processor).
## Remote access

Expand All @@ -65,24 +69,26 @@ might want to access remotely to the installer. If you know the IP address of th
need to point your browser to `https://$IP`.

For the case you do not know the address, or just for convenience, the Live ISO is configured to use
mDNS (sometimes called Avahi, Zeroconf, Bonjour) for hostname resolution. Therefore, connecting to `https://agama.local` should do the trick.
mDNS (sometimes called Avahi, Zeroconf, Bonjour) for hostname resolution. Therefore, connecting to
`https://agama.local` should do the trick.

>[!WARNING]
> Do not use the `.local` hostnames in untrusted networks (like public WiFi networks, shared
> networks), it is a security risk. An attacker can easily send malicious responses for the `.local`
> hostname resolutions and point you to a wrong Agama instance which could for example steal your
> root password!
> [!WARNING] Do not use the `.local` hostnames in untrusted networks (like public WiFi networks,
> shared networks), it is a security risk. An attacker can easily send malicious responses for the
> `.local` 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

* If you want to know how Agama works, you should read about [Agama's architecture](/doc/architecture.md)
* If you would like to [contribute](#how-to-contribute), you might be interested in:
* [Running Agama from sources](./doc/running.md).
* [Working with Agama's web server](./rust/WEB-SERVER.md).
* [Working with Agama's web UI](./web/README.md).
* You can check the overall status of the project through the [status page](/STATUS.md).
- If you want to know how Agama works, you should read about
[Agama's architecture](/doc/architecture.md)
- If you would like to [contribute](#how-to-contribute), you might be interested in:
- [Running Agama from sources](./doc/running.md).
- [Working with Agama's web server](./rust/WEB-SERVER.md).
- [Working with Agama's web UI](./web/README.md).
- You can check the overall status of the project through the [status page](/STATUS.md).

## How to Contribute

Expand Down
Binary file modified doc/images/screenshots/finished.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/screenshots/installing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/screenshots/overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/screenshots/product-selection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/screenshots/software-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/screenshots/storage-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed doc/images/screenshots/users-page.png
Binary file not shown.

0 comments on commit c6c5462

Please sign in to comment.