aboutsummaryrefslogtreecommitdiff
path: root/scripts/install
blob: b635ccc51cafb8a8953766bdec3398256b4bb020 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
#!/bin/bash

#=================================================
# GENERIC START
#=================================================
# IMPORT GENERIC HELPERS
#=================================================

source _common.sh
source /usr/share/yunohost/helpers
source ynh_install_ruby

#=================================================
# MANAGE SCRIPT FAILURE
#=================================================

ynh_clean_setup () {
	### Remove this function if there's nothing to clean before calling the remove script.
	true
}
# Exit if an error occurs during the execution of the script
ynh_abort_if_errors

#=================================================
# RETRIEVE ARGUMENTS FROM THE MANIFEST
#=================================================

domain=$YNH_APP_ARG_DOMAIN
path_url="/"
admin_mastodon=$YNH_APP_ARG_ADMIN
is_public=true
language=$YNH_APP_ARG_LANGUAGE

admin_mastodon_mail=$(ynh_user_get_info $admin_mastodon 'mail')
port_web=$(ynh_find_port 3000)
port_stream=$(ynh_find_port 4000)


app=$YNH_APP_INSTANCE_NAME

#=================================================
# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
#=================================================
ynh_print_info "Validating installation parameters..."

### If the app uses nginx as web server (written in HTML/PHP in most cases), the final path should be "/var/www/$app".
### If the app provides an internal web server (or uses another application server such as uwsgi), the final path should be "/opt/yunohost/$app"
final_path=/var/www/$app
test ! -e "$final_path" || ynh_die "This path already contains a folder"

# Normalize the url path syntax
path_url=$(ynh_normalize_url_path $path_url)

# Check web path availability
ynh_webpath_available $domain $path_url
# Register (book) web path
ynh_webpath_register $app $domain $path_url

#=================================================
# STORE SETTINGS FROM MANIFEST
#=================================================
ynh_print_info "Storing installation settings..."

ynh_app_setting_set $app domain      $domain
ynh_app_setting_set $app path $path_url
ynh_app_setting_set $app admin       $admin_mastodon
ynh_app_setting_set $app is_public $is_public
ynh_app_setting_set $app language    $language
ynh_app_setting_set $app port_web    $port_web
ynh_app_setting_set $app port_stream $port_stream

#=================================================
# STANDARD MODIFICATIONS
#=================================================


#=================================================
# INSTALL DEPENDENCIES
#=================================================
ynh_print_info "Installing dependencies..."

# TODO: add in a clean way backports and yarn

# Import debian archive pubkey, need on ARM arch
arch=$(uname -m)
if [[ "$arch" = arm*  ]]; then
	apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 8B48AD6246925553
	apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 7638D0442B90D010
fi

# Install source.list debian package backports & yarn
if [ "$(lsb_release --codename --short)" == "jessie" ]; then
	echo "deb http://httpredir.debian.org/debian jessie-backports main" | tee /etc/apt/sources.list.d/jessie-backports.list
fi
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list
ynh_package_update

# install nodejs
ynh_install_nodejs 8

# TODO: use the same mecanism with other files
ynh_install_app_dependencies $pkg_dependencies	

#=================================================
# CREATE A POSTGRESQL DATABASE
#=================================================
ynh_print_info "Creating a PostgreSQL database..."

# Create postgresql database
db_name="${app}_production"
db_pwd=$(ynh_string_random 30)
ynh_app_setting_set "$app" db_name "$db_name"
ynh_app_setting_set "$app" db_pwd "$db_pwd"
ynh_psql_test_if_first_run
ynh_psql_create_user "$app" "$db_pwd"
ynh_psql_execute_as_root \
"CREATE DATABASE $db_name ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' template=template0 OWNER $app;"

#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
ynh_print_info "Setting up source files..."

# Creates the destination directory and stores its location.
ynh_app_setting_set "$app" final_path "$final_path"
# Download all sources rbenv, ruby and mastodon

ynh_setup_source "$final_path/.rbenv"                    "app-rbenv"
ynh_setup_source "$final_path/.rbenv/plugins/ruby-build" "app-ruby-build"
ynh_setup_source "$final_path/live"                      "app-mastodon"

#=================================================
# NGINX CONFIGURATION
#=================================================
ynh_print_info "Configuring nginx web server..."

# Create a dedicated nginx config
ynh_replace_string "__PORT_WEB__"    "$port_web"    "../conf/nginx.conf"
ynh_replace_string "__PORT_STREAM__" "$port_stream" "../conf/nginx.conf"
ynh_add_nginx_config

#=================================================
# CREATE DEDICATED USER
#=================================================
ynh_print_info "Configuring system user..."

# Create a system user
ynh_system_user_create $app $final_path

#=================================================
# SPECIFIC SETUP
#=================================================
# INSTALLING RUBY
#=================================================

ynh_install_ruby --ruby_version=2.6.0

#=================================================
# MODIFY A CONFIG FILE
#=================================================

cp -a $final_path/live/.env.production.sample $final_path/live/.env.production
ynh_replace_string "REDIS_HOST=redis"         "REDIS_HOST=127.0.0.1"        "${final_path}/live/.env.production"
ynh_replace_string "DB_HOST=db"               "DB_HOST=/var/run/postgresql" "${final_path}/live/.env.production"
ynh_replace_string "DB_USER=postgres"         "DB_USER=${app}"              "${final_path}/live/.env.production"
ynh_replace_string "DB_NAME=postgres"         "DB_NAME=${db_name}"          "${final_path}/live/.env.production"
ynh_replace_string "DB_PASS="                 "DB_PASS=${db_pwd}"           "${final_path}/live/.env.production"
ynh_replace_string "LOCAL_DOMAIN=example.com" "LOCAL_DOMAIN=${domain}"      "${final_path}/live/.env.production"

language="$(echo $language | head -c 2)"
ynh_replace_string "# DEFAULT_LOCALE=de"      "DEFAULT_LOCALE=${language}"  "${final_path}/live/.env.production"

paperclip_secret=$(head -n128 /dev/urandom | tail -n +1 | tr -dc -d 'a-z0-9' | head -c128)
secret_key_base=$(head -n128 /dev/urandom | tail -n +1 | tr -dc -d 'a-z0-9' | head -c128)
otp_secret=$(head -n128 /dev/urandom | tail -n +1 | tr -dc -d 'a-z0-9' | head -c128)
ynh_replace_string "PAPERCLIP_SECRET=" "PAPERCLIP_SECRET=$paperclip_secret" "${final_path}/live/.env.production"
ynh_replace_string "SECRET_KEY_BASE="  "SECRET_KEY_BASE=$secret_key_base"   "${final_path}/live/.env.production"
ynh_replace_string "OTP_SECRET="       "OTP_SECRET=$otp_secret"             "${final_path}/live/.env.production"

ynh_replace_string "SMTP_LOGIN="                                 "#SMTP_LOGIN="                                     "${final_path}/live/.env.production"
ynh_replace_string "SMTP_PASSWORD="                              "#SMTP_PASSWORD="                                  "${final_path}/live/.env.production"
ynh_replace_string "SMTP_SERVER=smtp.mailgun.org"                "SMTP_SERVER=localhost"                            "${final_path}/live/.env.production"
ynh_replace_string "SMTP_PORT=587"                               "SMTP_PORT=25"                                     "${final_path}/live/.env.production"
ynh_replace_string "SMTP_FROM_ADDRESS=notifications@example.com" "SMTP_FROM_ADDRESS=$admin_mastodon@$domain"        "${final_path}/live/.env.production"
ynh_replace_string "#SMTP_AUTH_METHOD=plain"                     "SMTP_AUTH_METHOD=none"                            "${final_path}/live/.env.production"
ynh_replace_string "#SMTP_OPENSSL_VERIFY_MODE=peer"              "SMTP_OPENSSL_VERIFY_MODE=none"                    "${final_path}/live/.env.production"

#=================================================
# INSTALLING MASTODON
#=================================================
ynh_print_info "Installing Mastodon..."

chown -R "$app": "$final_path"

pushd "$final_path/live"
	su mastodon <<INSTALL
	    ynh_use_nodejs
		env PATH=$PATH /opt/rbenv/versions/2.6.0/bin/gem update --system
		env PATH=$PATH /opt/rbenv/versions/2.6.0/bin/gem install bundler --no-document
		env PATH=$PATH /opt/rbenv/versions/2.6.0/bin/bundle install \
		-j$(getconf _NPROCESSORS_ONLN) \
		--deployment --without development test
		env PATH=$PATH yarn install --pure-lockfile
		echo "SAFETY_ASSURED=1">> .env.production
		env PATH=$PATH RAILS_ENV=production /opt/rbenv/versions/2.6.0/bin/bundle exec rails db:migrate --quiet
		env PATH=$PATH RAILS_ENV=production /opt/rbenv/versions/2.6.0/bin/bundle exec rails assets:precompile --quiet
INSTALL
popd

#=================================================
# CREATE MASTODON ADMIN USER
#=================================================
ynh_print_info "Creating Mastodon Admin User..."

# Create user
pushd "$final_path/live"
	su mastodon <<SETADMIN
        env PATH=$PATH RAILS_ENV=production bin/tootctl accounts create '$admin_mastodon' --email='$admin_mastodon_mail' > acc.txt
        env PATH=$PATH RAILS_ENV=production bin/tootctl accounts modify $admin_mastodon --confirm
        env PATH=$PATH RAILS_ENV=production bin/tootctl accounts modify $admin_mastodon --role admin
SETADMIN
popd

admin_pass=$( cd $final_path/live && tail -1 acc.txt | head -1 | cut -c 15- )
ynh_secure_remove "$final_path/live/acc.txt"

#=================================================
# SETUP CRON JOB FOR REMOVING CACHE
#=================================================
ynh_print_info "Setuping a cron job for remiving cache..."

ynh_replace_string  "__FINAL_PATH__" "$final_path" ../conf/cron
ynh_replace_string "__USER__" "$app"  ../conf/cron
sudo cp -f ../conf/cron /etc/cron.d/$app 

#=================================================
# SETUP SYSTEMD
#=================================================
ynh_print_info "Configuring a systemd service..."

# Create a dedicated systemd config
ynh_replace_string "__PORT_WEB__"    "$port_web"    "../conf/mastodon-web.service"
ynh_replace_string "__PORT_STREAM__" "$port_stream" "../conf/mastodon-streaming.service"
ynh_add_systemd_config "$app-web"       "mastodon-web.service"
ynh_add_systemd_config "$app-sidekiq"   "mastodon-sidekiq.service"
ynh_add_systemd_config "$app-streaming" "mastodon-streaming.service"

systemctl start "$app-web.service" "$app-sidekiq.service" "$app-streaming.service"

#=================================================
# STORE THE CONFIG FILE CHECKSUM
#=================================================

# Calculate and store the config file checksum into the app settings
ynh_store_file_checksum "${final_path}/live/.env.production"

#=================================================
# GENERIC FINALIZATION
#=================================================
# SECURE FILES AND DIRECTORIES
#=================================================

### For security reason, any app should set the permissions to root: before anything else.
### Then, if write authorization is needed, any access should be given only to directories
### that really need such authorization.

# Set permissions to app files
chown -R "$app": "$final_path"

#=================================================
# ADVERTISE SERVICE IN ADMIN PANEL
#=================================================

# Add service YunoHost
yunohost service add "$app-web"
yunohost service add "$app-sidekiq"
yunohost service add "$app-streaming"

#=================================================
# SETUP SSOWAT
#=================================================
ynh_print_info "Configuring SSOwat..."

# Make app public if necessary
if [ $is_public -eq 1 ]
then
	# unprotected_uris allows SSO credentials to be passed anyway.
	ynh_app_setting_set $app unprotected_uris "/"
fi

#=================================================
# RELOAD NGINX
#=================================================
ynh_print_info "Reloading nginx web server..."

systemctl reload nginx

#=================================================
# SEND A README FOR THE ADMIN
#=================================================

message="Mastodon was successfully installed :)
Please open 'https://$domain$path_url'
The admin email is: $admin_mastodon_mail
The admin password is: $admin_pass
If you facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/mastodon_ynh"

ynh_send_readme_to_admin "$message" "$admin_mastodon"

#=================================================
# END OF SCRIPT
#=================================================

ynh_print_info "Installation of $app completed"