calamares / calamares Goto Github PK

Distribution-independent installer framework

CMake 4.84% Shell 1.56% QML 7.51% C++ 74.11% C 0.63% Python 8.06% Roff 3.29%

calamares's Introduction

Calamares: Distribution-Independent Installer Framework

Report a Bug	Translate	Contribute	Chat on Matrix: #calamares:kde.org	Wiki

Calamares is a distribution-independent system installer, with an advanced partitioning feature for both manual and automated partitioning operations. Calamares is designed to be customizable by distribution maintainers without the need for cumbersome patching, thanks to third-party branding and external modules support.

Target Audience

Calamares is a Linux installer; users who install Linux on a computer will hopefully use it just once, to install their Linux distribution. Calamares is not a "ready to use" application: distributions apply a huge amount of customization and configuration to Calamares, and the target audience for this repository is those distributions, and the people who make those Linux distros.

Calamares has some generic user documentation for end-users, but most of what we have is for distro developers.

Getting Calamares

Clone Calamares from GitHub. The default branch is called calamares.

git clone https://github.com/calamares/calamares.git

Calamares is a KDE-Frameworks and Qt-based, C++17, CMake-built application. The dependencies are explained in CONTRIBUTING.md.

Contributing to Calamares

Calamares welcomes PRs. New issues are welcome, too. There are both the Calamares core repository (this one) and an extensions repository (Calamares extensions).

Contributions to code, modules, documentation, the wiki, and the website are all welcome. There is more information in the CONTRIBUTING.md file.

Join the Conversation

GitHub Issues are one place for discussing Calamares if there are concrete problems or a new feature to discuss. Issues are not a help channel. Visit Matrix for help with configuration or compilation.

Regular Calamares development chit-chat happens in a Matrix room, #calamares:kde.org. Responsiveness is best during the day in Europe, but feel free to idle. Matrix is persistent, and we'll see your message eventually.

(needs a Matrix account)

calamares's People

Contributors

Stargazers

Watchers

Forkers

prodigeni toudi operatingsystemu kaosx kanevanguard shadeslayer rshipp jheengut jcdero krytarowski gormogon blackheartevony necrose99 aditmeno gozames dgikiller rogentos wangqian-channe mambasoft rajudev beaparna bhush9 almack mytea codeworkx lugarius mudler vedant1811 aosc-archive shahbaz17 manjaro-arm priyanshujain pandalinux gvsurenderreddy tctara fr34k8 onophris shainer samson1016 ajjames31 entityos pombredanne stikonas nurunner-linux manjaro highvoltage conan-kudo delkyd ashang paddatrapper stephangriesel aims-south-africa pimani awelkie xeon-zolt bloodshinoda megver83 gronau-it-cloud-computing enterstudio archbox-linux brunofb frugalware meets2tarun bill-auger nzogby thedayman97 kungfoo-linux winry-linux artix-linux jameslinus guidedlinux n3rdopolis blackpantheros damnwidget bangl isaagar tpgxyz vishwakperera bezzy1999 qt-widgets harleyzdub874 mdhorn hsitter cmacq2 ohsevin jamesbrink dyzmapl raurodse potatogim oberon-manjaro najibalghaeth frugalcore foxboron eliark abucodonosor galford-io wxl ximion dpvpro crazyrex

calamares's Issues

CAL-22: fix for issue #13

Jira issue originally created by user @teo:

CAL-20: [partition] Add a way to (re)create a partition table

Jira issue originally created by user @teo:

CAL-12: [partition] Turn PartitionModel into a tree model

Jira issue originally created by user @teo:

Having a real tree model should make it easier to implement the partition preview widget.

[libcalamares] Create a GlobalStorage singleton for data sharing between modules

Then also make the locale and keyboard modules store their data into it.

"After Install" Snapshot when using btrfs

It would be a real benefit for the user who installs on an btrfs filesystem to have an "After Install" or "Initial Configuration" snapshot that gets an entry in grub.
This allows the user whenever he wants to boot into the initial state of his system after the installation and is a good alternative to "safe mode" boot options in disaster cases.

This should be optional as a checkbox when choosing btrfs. (maybe activated by default as it only brings benefits for the majority of users)

[partitionmanager] Remove dependency on KIO

[ui] calamares doesn't start centered

It is early in development and I think this should not matter, but in XFCE calamares doesn't start centered.

CAL-19: [partition] Allow modifying settings of new partitions after they have been added

Jira issue originally created by user @teo:

Clicking the Edit button with a new partition selected should show the CreatePartitionDialog in "edition" mode.

CAL-18: [libcalamares] Plugin interface for CoreModules

Jira issue originally created by user @teo:

Create a plugin interface for CoreModules and a demo CoreModule.
Load them and add to JobQueue (+JobQueue configuration).
Look into Python CoreModules.

CAL-6: [libcalamares] Create a GlobalStorage singleton for data sharing between modules

Jira issue originally created by user @teo:

Then also make the locale and keyboard modules store their data into it.

[modules/keyboard] Look into grouping the keyboard models list by vendor or otherwise trimming it down

There's an XML file in /usr/share/X11/xkb/rules/ with structured vendor info.

[partition] Installer failed to create extended partition + logical partition in one go

When I try to create an extended partition and fill it with one ext2 logical partition, installation fails with the message:

The installer failed to update partition table on USB Flash Disk.
Could not update the system type for partition ‘New Partition’.

Looking at the disk after that, the extended partition has been created, but it does not contain any logical partition.

UI, page flow, basic needs

I'd like to get an opinion from all involved on the basics of how this installer looks and works.

As a start, I'll give my opinion.

GUI not full screen, window size about 800 x 500
progress shown in clear text labels, not a generic slider that only shows how far along, but no idea what steps are to come (or look back what steps were done)
page flow in click next > next order, no option for the user to choose what page will be worked on
no option in base ui/window menu to close the installer, only option to close is with a close button, with a dedicated warning connected and log output on close, so the user can't accidentally close
basic pages/widgets set for all distros:
- language
- location/worldmap
- keyboard layout
- user creation
- license agreement wdiget/page for proprietary software
- check for disk space/RAM/power/network
- and of course the big one, partitioning

CAL-27: [partition] Hide the partition type radio buttons when creating a partition on a GPT disk

Jira issue originally created by user @teo:

GPT does not have a concept of primary, extended or logical partition types, so the radio buttons in the CreatePartitionDialog dialog should be hidden when working on GPT disks.

[libcalamares] Plugin interface for CoreModules

Create a plugin interface for CoreModules and a demo CoreModule.
Load them and add to JobQueue (+JobQueue configuration).
Look into Python CoreModules.

CAL-21: [ui] calamares doesn't start centered

Jira issue originally created by user @teo:

It is early in development and I think this should not matter, but in XFCE calamares doesn't start centered.

[branding] Create a branding component/plugin/loader/whatever

This is on the application level, libcalamaresui. It needs to be done in order to finally be able to use qrc in Calamares.

CAL-15: Show an InstallationStep at the end of the preparation process

Jira issue originally created by user @teo:

I had to move the check for whether an item in the tree is current to the base class (ProgressTreeItem) so that it can be used for CategoryItem, since "Install" is a category item. Not fully satisfied with the idea, suggestions are welcome.

CAL-8: add ECM to CMakeLists,

Jira issue originally created by user @teo:

remove obsolete CONFIG

[partition] Allow modifying settings of new partitions after they have been added

Clicking the Edit button with a new partition selected should show the CreatePartitionDialog in "edition" mode.

[partition] Hide the partition type radio buttons when creating a partition on a GPT disk

GPT does not have a concept of primary, extended or logical partition types, so the radio buttons in the CreatePartitionDialog dialog should be hidden when working on GPT disks.

[modules] Additional module configuration

Add the option of reading an additional module-specific freeform configuration map from a module.conf file. This map would not be interpreted by ModuleManager like the rest of the config, it would be passed to the ViewStep implementation and would then be used for things like default timezone, strings, etc.

CAL-1: UI, page flow, basic needs

Jira issue originally created by user @teo:

I'd like to get an opinion from all involved on the basics of how this installer looks and works.

As a start, I'll give my opinion.

GUI not full screen, window size about 800 x 500
progress shown in clear text labels, not a generic slider that only shows how far along, but no idea what steps are to come (or look back what steps were done)
page flow in click next > next order, no option for the user to choose what page will be worked on
no option in base ui/window menu to close the installer, only option to close is with a close button, with a dedicated warning connected and log output on close, so the user can't accidentally close
basic pages/widgets set for all distros:
- language
- location/worldmap
- keyboard layout
- user creation
- license agreement wdiget/page for proprietary software
- check for disk space/RAM/power/network
- and of course the big one, partitioning

CAL-2: Partitioning page

Jira issue originally created by user @teo:

Since the partitioning pages will be very complex, i thought it would be nice to have a separate issue for that.

Here's my thought for the initial one: http://docs.fedoraproject.org/en-US/Fedora/18/html/Installation_Guide/images/diskpartsetup/disk-setup.png

i think that fedora did it nicely. The rule of thumb here would be that the user first needs to limit all available disks to which he actually wants to use. This would help in not showing up i.e. the thumb-drive with the live image inside the partitioning tool.