Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thanatisia/distro-installscript-arch
(Migrated) My linux distro installscript suite of scripts. Aims to be 1) Modular, 2) Customizable and 3) Portable. Designing this to eventually be a Standardized/Universal Distribution Installer framework where you can just modify the chroot installation process as specified by the developer, as well as the config files.
https://github.com/thanatisia/distro-installscript-arch
archlinux archlinux-installer bash install-script installer linux linux-distribution script shellscript
Last synced: about 1 month ago
JSON representation
(Migrated) My linux distro installscript suite of scripts. Aims to be 1) Modular, 2) Customizable and 3) Portable. Designing this to eventually be a Standardized/Universal Distribution Installer framework where you can just modify the chroot installation process as specified by the developer, as well as the config files.
- Host: GitHub
- URL: https://github.com/thanatisia/distro-installscript-arch
- Owner: Thanatisia
- License: mit
- Created: 2021-10-15T05:58:39.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-26T10:18:23.000Z (12 months ago)
- Last Synced: 2024-09-28T15:03:57.688Z (about 2 months ago)
- Topics: archlinux, archlinux-installer, bash, install-script, installer, linux, linux-distribution, script, shellscript
- Language: Shell
- Homepage: https://github.com/Thanatisia/distinstall-python
- Size: 153 KB
- Stars: 18
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Base Installation Script (ArchLinux Edition)
Linux Distribution Portable, Modular CLI/Terminal Base-Installation + Essential Scripts for ArchLinux
## NOTE
+ This project has been migrated and rewrote into python in this [repository](https://github.com/Thanatisia/distinstall-python), with a consideration on potentially going to write it in golang for the ability to compile into a single binary (do tell me how you feel about this in terms of usability), please follow the attached repository for future updates!
- Thank you once again for following this project and feel free to dm me on any of my social media and/or create an Issue/pull request if you have any ideas on
+ what to add
+ Bugs Encountered
## Table of Contents
- [Information](#information)
- [Setup](#setup)
- [Documentation](#documentation)
- [Wiki](#wiki)
- [FAQs](#faqs)
- [Remarks](#remarks)
- [Contacts](#contacts)
- [Updates](CHANGELOG.md)
## Information
### Background
Welcome to my (semi)automatic Linux distribution (trying-to-be-generic) installation script!
This project revolves primarily around the base installation area, but this project will also contain various scripts for Post-Installation support as well!
- The Project was first planned as I had to reinstall my ArchLinux (as do many Arch users) but had to do it manually. Thus, the concept bloomed when I considered
how to automatically install a consistent ArchLinux build with similar if not the same packages and users etc without having to re-type them.
- The project (specifically the Base Installation Linux Install script ) is designed to be
1. Modular
2. Portable,
3. Customizable
4. Configurable
- As you will see in [Usage](#usage), the end result will be that you *should* get the same build everytime consistently. The only time it might not may be if the installation process itself completely change
and/or the tools required by the target distribution changed, thus, leading to the next point
- The script has been formatted and structured in a way that if you want to create a Linux install script for another distro, you just need to
+ enter the functions that is specifically for that distro (according to the steps for installation)
+ change that line of code and that should do it, as some of the general steps are universal across the distro CLI-based installation steps
+ Thus, with the modular, containerized method, the modification of codes will be easier and customizable
### Files and Folders
- [SUPPORT.md](SUPPORT.md) : For a list of hardware/software support
- [Source codes](src) : This is the root working directory containing the source files, configuration and scripts
- [base-installation/](src/base-installation) : This is the Base Installation script. All files placed here have been tested from those found in dev (Development Folder). This is probably where you want to go first.
- [post-installation/](src/post-installation) : This is the Post-Installation related scripts. All files placed here have been tested from those found in dev
- [references/](references) : This references directory contains various useful files such as Sample configurations, Sample templates and Sample usage scripts.
- [development](dev) : This is the development directory. This directory is essentially the Nightly Build branch and to be considered as Testing or unsafe, just to be safe, please test the files found here in a Virtual Machine.
- [documentations](docs) : This contains all documentations and guides for references
+ including detailed setup; usage
## Setup
> This is a basic rundown of how to use the program, please refer to [Base Installation Manual](docs/manuals/distinstall.md) for a more detailed rundown
### Pre-Requisites
+ (Optional) Internet Connection
```
Required for curl and wget
```
### Dependencies (General)
+ curl
+ base-devel
+ arch-install-scripts
+ make
+ git
+ parted
### Obtaining Installer
- via Curl (Recommended)
```console
curl -L -O "https://raw.githubusercontent.com/Thanatisia/distro-installscript-arch/main/src/base-installation/distinstall"
```
- Change Permission for use (Execute [x] and User [u])
```console
chmod u+x distinstall
```
### Obtaining Config File
- Default config file
+ Default config file name : config.sh
+ WIP/TODO: check if a a config file exists (Default config file name is 'config.sh')
```console
./distinstall -g
```
- Generate custom config file
+ WIP/TODO: check if a a config file exists (Default config file name is 'config.sh')
```console
./distinstall -c [new-config-file-name]
```
- (OPTIONAL) Curling the example config.sh
```console
curl -L -O "https://raw.githubusercontent.com/Thanatisia/distro-installscript-arch/main/docs/configs/config.sh"
```
- Edit config file
```console
$EDITOR [config file name]
```
### Obtaining additional helper utilities/files
- Makefile
- (OPTIONAL) Obtaining Makefile
+ I designed this Makefile to automate and make running the installer easier
```console
curl -L -O "https://raw.githubusercontent.com/Thanatisia/distro-installscript-arch/main/docs/configs/Makefile"
```
- (OPTIONAL) Editing the Makefile
+ If you have obtained the Makefile and will be using this to install
+ Edit the Makefile and specify your device labels and information
```console
$EDITOR Makefile
```
### Obtaining all necessary files
> Includes the above - Installer, config file and additional utilities
- Downloading the latest release
> Includes the above - Installer, config file and additional utilities
- Download the latest release from 'https://github.com/Thanatisia/distro-installscript-arch/releases/latest'
- Download via the Makefile
- Download Makefile
```console
curl -L -O https://raw.githubusercontent.com/Thanatisia/distro-installscript-arch/main/src/base-installation/Makefile
```
- Execute the 'download' rule/target
+ You should get all the necessary files required (i.e. installer, generated configuration file)
```console
make download
```
## Documentation
### Synopsis/Syntax
```console
./distinstall {options} [positional]
```
### Parameters
- Optional Parameters
- With Arguments
+ -c [config-file-name] | --config [config-file-name] : Set custom configuration file name
+ -d [target-disk-name] | --target-disk [target-disk-name] : Set target disk name
+ -e [default-editor] | --editor [default-editor] : Set default text editor
+ -m [DEBUG|RELEASE] | --mode [DEBUG|RELEASE] : Set mode (DEBUG|RELEASE)
- Flags
+ -g | --generate-config : Generate configuration file
+ -h | --help : Display this help menu and all commands/command line arguments
+ --fdisk : Open up fdisk for manual partition configuration
+ --cfdisk : Open up cfdisk for manual partition configuration
- Positional Parameters
+ start : Start the installer
### Usage
1. Default (Test Install; Did not specify target disk name explicitly)
```console
./distinstall start
```
2. Test Install; with target disk name specified as flag
```console
./distinstall -d "/dev/sdX" start
```
3. Test Install; with target disk name specified with environment variable TARGET_DISK_NAME
```console
TARGET_DISK_NAME="/dev/sdX" ./distinstall start
```
4. Test Install; with custom configuration file
```console
./distinstall -c "new config file" -d "/dev/sdX" start
```
5. Start installation (Did not specify target disk name explicitly)
```console
sudo ./distinstall -m RELEASE start
```
6. Start installation (with target disk name specified as flag)
```console
sudo ./distinstall -d "/dev/sdX" -m RELEASE start
```
7. Start installation (with target disk name specified with environment variable TARGET_DISK_NAME)
```console
sudo TARGET_DISK_NAME="/dev/sdX" ./distinstall -m RELEASE start
```
8. Start installation (with custom configuration file)
```console
sudo ./distinstall -c "new config file" -d "/dev/sdX" -m RELEASE start
```
9. Open up fdisk for Manual Partitioning
```console
sudo ./distinstall --fdisk
```
10. Open up cfdisk for Manual Partitioning
```console
sudo ./distinstall --cfdisk
```
11. Test Install; using Makefile
```console
make testinstall
```
12. Start installation; using Makefile
```console
sudo make install
```
13. Dis/Unmount using Makefile
```console
sudo make clean
```
14. Generate configuration file using Makefile
```console
make genscript
```
## Wiki
### Modes
+ DEBUG (Default) : Test install; Allows you to see all the commands that will be executed if you set the MODE to 'RELEASE'; set by default to prevent accidental reinstallation/overwriting
+ RELEASE : Performs the real RELEASE; must use with sudo
### Environment Variables
+ TARGET_DISK_NAME : This is used in the environment variable to specify the target disk you want to install with
### Configuration
+ Please refer to the [configuration guide](docs/installer%20configuration.md) for full information with regards to editing the configuration file
## FAQs
## Remarks
- Please do contact me in any of the platforms below if you have any ideas | bugs | comments | suggestions or if you just wanna talk!
+ I am open for suggestions as well as talking to everyone
+ thank you again for using!
## Contacts
+ [Twitter: @phantasu](https://twitter.com/phantasu)
+ [GitHub: @thanatisia](https://github.com/Thanatisia)
+ [My Portfolio Website](https://thanatisia.github.io/my-portfolio-website)
+ [Fiverr: @fortissimasura](https://fiverr.com/fortissimasura)
+ [Email: [email protected]](mailto:[email protected])