Update README and install scripts

Author: adrien1018

Dockerfile

@@ -31,8 +31,8 @@ production:\n\
   <<: *default\n\
   database: tioj_production"\
 > config/database.yml
-RUN cp config/settings.yml.example config/settings.yml
 
+RUN EDITOR=true rails credentials:edit
 RUN rails assets:precompile
 
 # Move public/ to public-tmp/ since we're going to override it with 'volumes';

README.md

@@ -15,7 +15,7 @@ It is recommended to run this script on a freshly-installed machine. This script
 
 The systemd service names are `nginx.service` and `tioj-judge.service`. The configuration files are located at `/opt/nginx/conf` and `/etc/tioj-judge.conf`. You can modify them and reload/restart the services.
 
-If password recovery is needed, [setup credentials](#credentials) after the installation is completed, or pass the `SMTP_*` and `MAIL_*` environment variables to `bash` just like those in `.env.example`.
+If password recovery is needed, [setup the settings file](#settings) after the installation is completed, or pass the `SMTP_*` and `MAIL_*` environment variables to `bash` just like those in `.env.example`.
 
 This script is tested on Ubuntu 20.04 LTS and 22.04 LTS. It also works on Arch Linux, but direct installation on Arch Linux is not recommended since it involves rebuilding some community packages for static libraries.
 
@@ -27,31 +27,9 @@ It is strongly recommended to mount tmpfs on `/tmp` by adding `tmpfs /tmp tmpfs
     - The `SMTP_*` and `MAIL_*` variables are only added if password recovery function is needed. Without them, the function is automatically disabled.
 2. `docker-compose up -d` and enjoy TIOJ on port 4000.
 
-### Credentials
-
-Some settings is managed by the Rails credentials system. It can be set via `RAILS_ENV=production rails credentials:edit`. Besides `secret_key_base`, the following fields can be added to optionally enable password recovery & Sentry monitoring:
-
-```yaml
-# Password recovery settings
-mail_settings:
-  smtp_settings: # SMTP server settings; it will be passed to config.action_mailer.smtp_settings
-    address: smtp.example.com
-    port: 587
-    user_name: [email protected]
-    password: some_password
-    enable_starttls_auto: true
-  url_options:
-    host: https://tioj.example.com # the URL of the website, used to generate the link in the email
-  sender: tioj.example.com # email sender
-
-# Sentry settings
-sentry_dsn: https://[email protected]/xxxx # copy from your sentry project
-```
-
-## Current Development Environment
+### Settings
 
-Ruby: 3.1.2
-Rails: 7.0.3
+If password recovery and/or Sentry monitoring is needed, setup `config/settings.yml` using the format of `config/settings.yml.example`. The old method of using `rails credentials:edit` is deprecated.
 
 ## Judge Management
 

config/settings.yml.example

@@ -1,4 +1,6 @@
 shared:
+  # Omit any section if the function is not needed
+
   # Password recovery settings
   mail_settings:
     smtp_settings: # SMTP server settings; it will be passed to config.action_mailer.smtp_settings

docker-compose.yml

@@ -52,7 +52,7 @@ services:
       - /srv/tioj/judge-td-pool:/var/lib/tioj-judge/td-pool
       - /srv/tioj/judge-testdata:/var/lib/tioj-judge/testdata
     tmpfs:
-      - /tmp
+      - /tmp:exec
     privileged: true
     network_mode: host
     pid: host

scripts/install.sh

@@ -13,7 +13,7 @@ if [[ "${SMTP_USERNAME:-}" != "" && "${SMTP_PASSWORD:-}" != "" ]]; then
 else
   echo 'SMTP settings not detected. Will disable password recovery.'
 fi
-echo 'You can change this later by editing/adding/removing the `mail_settings` section in `rails credential:edit`'
+echo 'You can change this later by editing `config/settings.yml` according to `config/settings.yml.example`.'
 sleep 1
 
 { # prevent sudo timeout
@@ -136,43 +136,28 @@ production:
   <<: *default
   database: tioj_production
 EOF
-cp config/settings.yml.example config/settings.yml
 
 # Setup web server
 FETCH_KEY=$(head -c 32 /dev/urandom | xxd -ps -c 128)
 export RAILS_ENV=production
 
-TEMPFILE=$(mktemp)
-EDITOR=cat rails credentials:edit | head -n -1 | tail -n +8 > "$TEMPFILE"
 if [[ "${SMTP_USERNAME:-}" != "" && "${SMTP_PASSWORD:-}" != "" ]]; then
-  cat <<EOF >> "$TEMPFILE"
-mail_settings:
-  smtp_settings:
-    address: ${SMTP_ADDRESS:-smtp.gmail.com}
-    port: ${SMTP_PORT:-587}
-    user_name: $SMTP_USERNAME
-    password: $SMTP_PASSWORD
-    enable_starttls_auto: true
-  url_options:
-    host: ${MAIL_HOSTNAME:-hostname}
-  sender: ${MAIL_SENDER:-$SMTP_USERNAME}
-EOF
-else
-  cat <<EOF >> "$TEMPFILE"
-#mail_settings:
-#  smtp_settings:
-#    address: smtp.example.com
-#    port: 587
-#    user_name: email_username
-#    password: email_password
-#    enable_starttls_auto: true
-#  url_options:
-#    host: http://tioj.example.com
-#  sender: [email protected]
+  cat <<EOF > config/settings.yml
+shared:
+  mail_settings:
+    smtp_settings:
+      address: ${SMTP_ADDRESS:-smtp.gmail.com}
+      port: ${SMTP_PORT:-587}
+      user_name: $SMTP_USERNAME
+      password: $SMTP_PASSWORD
+      enable_starttls_auto: true
+    url_options:
+      host: ${MAIL_HOSTNAME:-hostname}
+    sender: ${MAIL_SENDER:-$SMTP_USERNAME}
 EOF
 fi
-EDITOR="mv $TEMPFILE" rails credentials:edit
 
+EDITOR=true rails credentials:edit
 rails assets:precompile
 TIOJ_KEY=$FETCH_KEY rails db:setup
 

scripts/run_server.sh

@@ -9,24 +9,22 @@ if [ "$1" == "1" ]; then
     rsync -avh public-tmp/ public/
     rm -rf public-tmp
 
-    # Create credential files from environment
-    TEMPFILE=$(mktemp)
-    EDITOR=cat rails credentials:edit | head -n -1 | tail -n +8 > "$TEMPFILE"
+    # Create settings file from environment
     if [[ "${SMTP_USERNAME:-}" != "" && "${SMTP_PASSWORD:-}" != "" ]]; then
-      cat <<EOF >> "$TEMPFILE"
-mail_settings:
-  smtp_settings:
-    address: ${SMTP_ADDRESS:-smtp.gmail.com}
-    port: ${SMTP_PORT:-587}
-    user_name: $SMTP_USERNAME
-    password: $SMTP_PASSWORD
-    enable_starttls_auto: true
-  url_options:
-    host: ${MAIL_HOSTNAME:-hostname}
-  sender: ${MAIL_SENDER:-$SMTP_USERNAME}
+      cat <<EOF > config/settings.yml
+shared:
+  mail_settings:
+    smtp_settings:
+      address: ${SMTP_ADDRESS:-smtp.gmail.com}
+      port: ${SMTP_PORT:-587}
+      user_name: $SMTP_USERNAME
+      password: $SMTP_PASSWORD
+      enable_starttls_auto: true
+    url_options:
+      host: ${MAIL_HOSTNAME:-hostname}
+    sender: ${MAIL_SENDER:-$SMTP_USERNAME}
 EOF
     fi
-    EDITOR="mv $TEMPFILE" rails credentials:edit
   fi
   until timeout 2s nc -z db 3306; do
     sleep 1