Compare commits

...

6 commits

Author SHA1 Message Date
f0c03d6b15 fix: install composer dependencies when --install=n is passed (#9)
Composer packages should still be installed even if the `--install=n` flag is set. The only thing "--install=n" won't do is download and add git submodules

Reviewed-on: https://codeberg.org/vegvisir/install/pulls/9
2025-08-07 12:30:25 +02:00
vlw
ce6d7fae60 doc(style): use h3 heading size for argument references in README (#8)
Reviewed-on: https://codeberg.org/vegvisir/install/pulls/8
Co-authored-by: vlw <victor@vlw.se>
Co-committed-by: vlw <victor@vlw.se>
2025-08-07 10:39:20 +02:00
vlw
8859a741d3 doc(feat): add --install and --dir references to README (#7)
Reviewed-on: https://codeberg.org/vegvisir/install/pulls/7
Co-authored-by: vlw <victor@vlw.se>
Co-committed-by: vlw <victor@vlw.se>
2025-08-07 10:37:36 +02:00
16c1a2df10 feat: add --dir named argument and use --install=n as flag for config only (#6)
This PR repurposes the `--install` argument as a flag to disable download and installation of the Vegvisir git submodule.

A new flag `--dir` is used to specify the install directory instead of `--install`.

Reviewed-on: https://codeberg.org/vegvisir/install/pulls/6
2025-08-07 10:32:52 +02:00
9ae80a1707 fic: remove optional parameters from generated env.ini (#4)
I will remove generated envvars for optional parameters. Vegvisir will automatically fall back to its internal defaults if certain parameters are absent.

I had to leave `worker_magic_pathname` in for now thought since the Vegvisir default for that is incorrect. When [PR #60](https://codeberg.org/vegvisir/vegvisir/pulls/60) is merged into the Vegvisir master, I will remove it from here.

Reviewed-on: https://codeberg.org/vegvisir/install/pulls/4
2025-08-07 06:46:18 +02:00
7484c2370b feat: add optional CLI arguments (#5)
This PR makes headless installation possible by passing optional named arguments to the install script.

Reviewed-on: https://codeberg.org/vegvisir/install/pulls/5
2025-08-07 06:42:05 +02:00
2 changed files with 115 additions and 30 deletions

View file

@ -1,13 +1,40 @@
# 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` - Don't install, only configure Vegvisir
```sh
./install.sh --install=n
```
Pass `--install=n` to prevent download and installation of the Vegvisir git submodule. Use this option if you're version controlling Vegvisir from your project repository.
### `--dir` - Installation directory
```sh
./install.sh --dir="/path/to/project"
```
Pass a `--dir` argument with a value of a directory Vegvisir should consider its [`root_path`](https://vegvisir.vlw.se/docs/Reference/Env#root_path).
### `--overwrite` - 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.

View file

@ -1,7 +1,11 @@
#!/bin/bash
# Get the current working directory
cwd=$(pwd)
# Initialize variables
cwd=""
dir=""
install=""
example=""
overwrite=""
echo_err() {
echo "!! -> $1"
@ -33,16 +37,19 @@ 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
# Download and install the Vegvisir repository
if [[ "$install" != "n" ]]; then
if ! [ -d "vegvisir" ] ; then
git submodule add https://codeberg.org/vegvisir/vegvisir
fi
# Update submodules
git submodule update --init --recursive
fi
# Install dependencies with composer
(cd vegvisir && composer install --classmap-authoritative)
@ -50,8 +57,15 @@ install_vegvisir() {
# Bail out if composer didn't create a vendor folder
if ! [ -d "vegvisir/vendor" ] ; then
echo_err "Something went wrong with the installation."
# Script was not run with the install flag disabled, this is probably a bug
if [[ "$install" != "n" ]]; then
exit_report
fi
echo_err "Make sure you have cloned the Vegvisir repository. Or run without '--install=n'."
exit 1
fi
}
configure_vegvisir() {
@ -61,12 +75,14 @@ configure_vegvisir() {
fi
# A configuration file already exists
if [ -f "vegvisir/.env.ini" ] ; then
if [[ -f "vegvisir/.env.ini" ]] ; then
if ! [[ -n "$overwrite" ]]; 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
read -p "Do you want to overwrite this file? (y/n): " overwrite </dev/tty
fi
# Check the user's response
if [[ "$choice" == "y" || "$choice" == "Y" ]] ; then
if [[ "$overwrite" == "y" || "$overwrite" == "Y" ]] ; then
echo "Removing existing Vegvisir configuration and proceeding with the installation in ${cwd}..."
rm vegvisir/.env.ini
else
@ -81,8 +97,6 @@ configure_vegvisir() {
"root_path = '${cwd}'"
"shell_page = 'public/shell'"
"public_path = 'public/'"
"worker_magic_pathname = '/__vvnavwrkr'"
"rfc_4288_url = 'https://raw.githubusercontent.com/apache/httpd/refs/heads/trunk/docs/conf/mime.types'"
)
for line in "${config[@]}" ; do
@ -152,28 +166,72 @@ generate_example_website() {
}
main() {
# Get the current working directory
cwd=$(pwd)
check_sys_depend
install_vegvisir
configure_vegvisir
echo "Vegvisir has been sucessfully installed."
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
--dir=*)
dir="${arg#*=}"
;;
--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 "$dir" ]; then
if ! [ -d "$dir" ]; then
echo_err "Installation aborted: '$dir' is not a directory"
exit 1
fi
# Move to install directory and run main
cd $dir
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}..."
echo "Proceeding with the installation in $(pwd)..."
main
else
echo "Installation aborted."