]> BookStack Code Mirror - devops/blob - scripts/installation-debian-13.sh
Debian 13 script: Fixed mysql use for mariadb, removed composer use
[devops] / scripts / installation-debian-13.sh
1 #!/bin/bash
2
3 echo "THIS SCRIPT IS NOT CONSIDERED OFFICIALLY SUPPORTED!"
4 echo "Only our Ubuntu LTS scripts are considered supported. This is community"
5 echo "maintained and provided for convenience. It may not be up-to-date or may"
6 echo "have unresolved issues. Use with caution."
7 echo ""
8
9 echo "This installs a new BookStack instance on a fresh Debian 13 (Trixie) server."
10 echo "This script does not ensure system security."
11 echo ""
12
13 # Generate a path for a log file to output into for debugging
14 LOGPATH=$(realpath "bookstack_install_$(date +%s).log")
15
16 # Get the current user running the script
17 SCRIPT_USER="${SUDO_USER:-$USER}"
18
19 # Get the current machine IP address
20 CURRENT_IP=$(ip addr | grep 'state UP' -A4 | grep 'inet ' | awk '{print $2}' | cut -f1  -d'/')
21
22 # Generate a password for the database
23 DB_PASS="$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 13)"
24
25 # The directory to install BookStack into
26 BOOKSTACK_DIR="/var/www/bookstack"
27
28 # Get the domain from the arguments (Requested later if not set)
29 DOMAIN=$1
30
31 # Prevent interactive prompts in applications
32 export DEBIAN_FRONTEND=noninteractive
33
34 # Echo out an error message to the command line and exit the program
35 # Also logs the message to the log file
36 function error_out() {
37   echo "ERROR: $1" | tee -a "$LOGPATH" 1>&2
38   exit 1
39 }
40
41 # Echo out an information message to both the command line and log file
42 function info_msg() {
43   echo "$1" | tee -a "$LOGPATH"
44 }
45
46 # Run some checks before installation to help prevent messing up an existing
47 # web-server setup.
48 function run_pre_install_checks() {
49   # Check we're running as root and exit if not
50   if [[ $EUID -gt 0 ]]
51   then
52     error_out "This script must be ran with root/sudo privileges"
53   fi
54
55   # Check if Apache appears to be installed and exit if so
56   if [ -d "/etc/apache2/sites-enabled" ]
57   then
58     error_out "This script is intended for a fresh server install, existing apache config found, aborting install"
59   fi
60
61   # Check if MySQL/MariaDB appears to be installed and exit if so
62   if [ -d "/var/lib/mysql" ]
63   then
64     error_out "This script is intended for a fresh server install, existing MySQL data found, aborting install"
65   fi
66 }
67
68 # Fetch domain to use from first provided parameter,
69 # Otherwise request the user to input their domain
70 function run_prompt_for_domain_if_required() {
71   if [ -z "$DOMAIN" ]
72   then
73     info_msg ""
74     info_msg "Enter the domain (or IP if not using a domain) you want to host BookStack on and press [ENTER]."
75     info_msg "Examples: my-site.com or docs.my-site.com or ${CURRENT_IP}"
76     read -r DOMAIN
77   fi
78
79   # Error out if no domain was provided
80   if [ -z "$DOMAIN" ]
81   then
82     error_out "A domain must be provided to run this script"
83   fi
84 }
85
86 # Install core system packages
87 function run_package_installs() {
88   apt update
89   apt install -y git unzip apache2 curl mariadb-server php8.4 \
90   php8.4-fpm php8.4-curl php8.4-mbstring php8.4-ldap php8.4-xml php8.4-zip php8.4-gd php8.4-mysql
91 }
92
93 # Set up database
94 function run_database_setup() {
95   # Ensure database service has started
96   systemctl start mariadb.service
97   sleep 3
98
99   # Create the required user database, user and permissions in the database
100   mysql -u root --execute="CREATE DATABASE bookstack;"
101   mysql -u root --execute="CREATE USER 'bookstack'@'localhost' IDENTIFIED BY '$DB_PASS';"
102   mysql -u root --execute="GRANT ALL ON bookstack.* TO 'bookstack'@'localhost';FLUSH PRIVILEGES;"
103 }
104
105 # Download BookStack
106 function run_bookstack_download() {
107   cd /var/www || exit
108   git clone https://github.com/BookStackApp/BookStack.git --branch release --single-branch bookstack
109 }
110
111 # Install BookStack composer dependencies
112 function run_download_bookstack_vendor_files() {
113   cd "$BOOKSTACK_DIR" || exit
114   php bookstack-system-cli download-vendor
115 }
116
117 # Copy and update BookStack environment variables
118 function run_update_bookstack_env() {
119   cd "$BOOKSTACK_DIR" || exit
120   cp .env.example .env
121   sed -i.bak "s@APP_URL=.*\$@APP_URL=http://$DOMAIN@" .env
122   sed -i.bak 's/DB_DATABASE=.*$/DB_DATABASE=bookstack/' .env
123   sed -i.bak 's/DB_USERNAME=.*$/DB_USERNAME=bookstack/' .env
124   sed -i.bak "s/DB_PASSWORD=.*\$/DB_PASSWORD=$DB_PASS/" .env
125   # Generate the application key
126   php artisan key:generate --no-interaction --force
127 }
128
129 # Run the BookStack database migrations for the first time
130 function run_bookstack_database_migrations() {
131   cd "$BOOKSTACK_DIR" || exit
132   php artisan migrate --no-interaction --force
133 }
134
135 # Set file and folder permissions
136 # Sets current user as owner user and www-data as owner group then
137 # provides group write access only to required directories.
138 # Hides the `.env` file so it's not visible to other users on the system.
139 function run_set_application_file_permissions() {
140   cd "$BOOKSTACK_DIR" || exit
141   chown -R "$SCRIPT_USER":www-data ./
142   chmod -R 755 ./
143   chmod -R 775 bootstrap/cache public/uploads storage
144   chmod 740 .env
145
146   # Tell git to ignore permission changes
147   git config core.fileMode false
148 }
149
150 # Setup apache with the needed modules and config
151 function run_configure_apache() {
152   # Enable required apache modules and config
153   a2enmod rewrite proxy_fcgi setenvif
154   a2enconf php8.4-fpm
155
156   # Set-up the required BookStack apache config
157   cat >/etc/apache2/sites-available/bookstack.conf <<EOL
158 <VirtualHost *:80>
159   ServerName ${DOMAIN}
160
161   ServerAdmin webmaster@localhost
162   DocumentRoot /var/www/bookstack/public/
163
164   <Directory /var/www/bookstack/public/>
165       Options -Indexes +FollowSymLinks
166       AllowOverride None
167       Require all granted
168       <IfModule mod_rewrite.c>
169           <IfModule mod_negotiation.c>
170               Options -MultiViews -Indexes
171           </IfModule>
172
173           RewriteEngine On
174
175           # Handle Authorization Header
176           RewriteCond %{HTTP:Authorization} .
177           RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
178
179           # Redirect Trailing Slashes If Not A Folder...
180           RewriteCond %{REQUEST_FILENAME} !-d
181           RewriteCond %{REQUEST_URI} (.+)/$
182           RewriteRule ^ %1 [L,R=301]
183
184           # Handle Front Controller...
185           RewriteCond %{REQUEST_FILENAME} !-d
186           RewriteCond %{REQUEST_FILENAME} !-f
187           RewriteRule ^ index.php [L]
188       </IfModule>
189   </Directory>
190
191   ErrorLog \${APACHE_LOG_DIR}/error.log
192   CustomLog \${APACHE_LOG_DIR}/access.log combined
193
194 </VirtualHost>
195 EOL
196
197   # Disable the default apache site and enable BookStack
198   a2dissite 000-default.conf
199   a2ensite bookstack.conf
200
201   # Restart apache to load new config
202   systemctl restart apache2
203   # Ensure php-fpm service has started
204   systemctl start php8.4-fpm.service
205 }
206
207 info_msg "This script logs full output to $LOGPATH which may help upon issues."
208 sleep 1
209
210 run_pre_install_checks
211 run_prompt_for_domain_if_required
212 info_msg ""
213 info_msg "Installing using the domain or IP \"$DOMAIN\""
214 info_msg ""
215 sleep 1
216
217 info_msg "[1/8] Installing required system packages... (This may take several minutes)"
218 run_package_installs >> "$LOGPATH" 2>&1
219
220 info_msg "[2/8] Preparing MySQL database..."
221 run_database_setup >> "$LOGPATH" 2>&1
222
223 info_msg "[3/8] Downloading BookStack to ${BOOKSTACK_DIR}..."
224 run_bookstack_download >> "$LOGPATH" 2>&1
225
226 info_msg "[4/8] Downloading PHP dependency files..."
227 run_download_bookstack_vendor_files >> "$LOGPATH" 2>&1
228
229 info_msg "[5/8] Creating and populating BookStack .env file..."
230 run_update_bookstack_env >> "$LOGPATH" 2>&1
231
232 info_msg "[6/8] Running initial BookStack database migrations..."
233 run_bookstack_database_migrations >> "$LOGPATH" 2>&1
234
235 info_msg "[7/8] Setting BookStack file & folder permissions..."
236 run_set_application_file_permissions >> "$LOGPATH" 2>&1
237
238 info_msg "[8/8] Configuring apache server..."
239 run_configure_apache >> "$LOGPATH" 2>&1
240
241 info_msg "----------------------------------------------------------------"
242 info_msg "Setup finished, your BookStack instance should now be installed!"
243 info_msg "- Default login email: admin@admin.com"
244 info_msg "- Default login password: password"
245 info_msg "- Access URL: http://$CURRENT_IP/ or http://$DOMAIN/"
246 info_msg "- BookStack install path: $BOOKSTACK_DIR"
247 info_msg "- Install script log: $LOGPATH"
248 info_msg "---------------------------------------------------------------"
Morty Proxy This is a proxified and sanitized view of the page, visit original site.