vegvisir/install
1
0
Fork 0
mirror of https://codeberg.org/vegvisir/install.git synced 2025-09-13 16:23:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: add optional CLI arguments (#5)

Browse source 
This PR makes headless installation possible by passing optional named arguments to the install script.

Reviewed-on: https://codeberg.org/vegvisir/install/pulls/5
This commit is contained in:
Victor Westerlund 2025-08-07 06:42:05 +02:00
parent 0f23cf1e16
commit 7484c2370b
2 changed files with 83 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -1,13 +1,34 @@
# Vegvisir installer
This script will automatically install and configure Vegvisir from in a fresh git repository.
Run this script from a git repository to automatically install and configure Vegvisir as a git submodule to your project.
## Important
The script will only run on Linux environments with `coreutils` installed (for now).
> [!IMPORTANT]
> The script will only run in environments with Bash and `coreutils` installed (for now).
# Get started
1. Create a repository for your website
2. Run this command from the root directory of your local repository
1. Create a git repository for your project.
2. Run this command from the root directory of your local repository.
```sh
curl -fsSL https://href.vlw.se/vegvisir/install | bash
```
curl -fsSL https://codeberg.org/vegvisir/install/raw/branch/master/install.sh | bash
```
# Arguments
You can pass optional named arguments to this script for headless installation of Vegvisir.
## `--install` - Installation directory
```sh
./install.sh --install="/path/to/project"
```
Pass an `--install` argument with a value of a directory Vegvisir should consider its [`root_path`](https://vegvisir.vlw.se/docs/Reference/Env#root_path).
## `--override` - Overwrite configuration files
```sh
./install.sh --overwrite=y
```
Pass `--overwrite=y` to replace existing Vegvisir configuration files.
## `--example` - Generate example website
```sh
./install.sh --example=n
```
Pass `--overwrite=n` to disable generation of an example website after installation.

67
install.sh
View file

@ -1,7 +1,10 @@
#!/bin/bash
# Get the current working directory
cwd=$(pwd)
# Initialize variables
cwd=""
install=""
example=""
overwrite=""
echo_err() {
echo "!! -> $1"
@ -33,7 +36,7 @@ check_sys_depend() {
install_vegvisir() {
if ! [ -d ".git" ] ; then
echo_err "Not in a git repository"
echo_err "Installation aborted: '$cwd' is not a git repository"
exit 1
fi
@ -61,7 +64,7 @@ configure_vegvisir() {
fi
# A configuration file already exists
if [ -f "vegvisir/.env.ini" ] ; then
if [[ -f "vegvisir/.env.ini" && "$overwrite" != "y" ]] ; then
echo "A Vegvisir configuration file already exists at: ${cwd}/vegvisir/.env.ini"
read -p "Do you want to overwrite this file? (y/n): " choice </dev/tty
@ -152,29 +155,69 @@ generate_example_website() {
}
main() {
# Get the current working directory
cwd=$(pwd)
check_sys_depend
install_vegvisir
configure_vegvisir
echo "Vegvisir has been sucessfully installed."
read -p "Do you want to generate a simple example website to start from? (y/n): " choice </dev/tty
# Check the user's response
if [[ "$choice" == "y" || "$choice" == "Y" ]] ; then
generate_example_website
if [[ "$example" != "n" ]]; then
read -p "Do you want to generate a simple example website to start from? (y/n): " choice </dev/tty
# Check the user's response
if [[ "$choice" == "y" || "$choice" == "Y" ]] ; then
generate_example_website
fi
fi
echo "Done! Thank you for choosing Vegvisir :)"
exit 0
}
# Loop through all arguments
for arg in "$@"; do
case $arg in
--install=*)
install="${arg#*=}"
;;
--overwrite=*)
overwrite="${arg#*=}"
;;
--example=*)
example="${arg#*=}"
;;
*)
echo_err "Unknown argument: $arg"
;;
esac
done
# Start execution immediately if an install directory was passed
if [ -n "$install" ]; then
if ! [ -d "$install" ]; then
echo_err "Installation aborted: '$install' is not a directory"
exit 1
fi
# Move to install directory and run main
cd $install
main
fi
# Prompt the user for confirmation
echo "You are currently in: ${cwd}"
echo "You are currently in: $(pwd)"
read -p "Do you want to proceed with the installation in this directory? (y/n): " choice </dev/tty
# Check the user's response
if [[ "$choice" == "y" || "$choice" == "Y" ]] ; then
echo "Proceeding with the installation in ${cwd}..."
main
echo "Proceeding with the installation in $(pwd)..."
main
else
echo "Installation aborted."
echo "Installation aborted."
fi