Skip to content

Latest commit

 

History

History
173 lines (140 loc) · 6.69 KB

README.md

File metadata and controls

173 lines (140 loc) · 6.69 KB
Raw

DIPC clock-in software

A software that will track it's users' clock-in and clock-out times.

About the project

This project aims to be the software that DIPC uses to register and track it's users working hours, to be able to abide by the Spanish law.

In order to do so, we've implemented a front-end web application made with Angular and hosted with Nginx, and a back-end restful API made with ExpressJS, connected to a MariaDB database that stores information about times and issues of it's users.

This project uses Vagrant for testing and development purposes, but it doesn't require a Vagrant machine for production. The restful API uses Bunyan for logging and PM2 to monitor the proccess.

Getting started

Requirements

  • A server to host both the front-end application and the restful API, as well as root privileges. All of the tests have been made on a CentOS 7 OS.

Installing

Once you have the server up and running, following the Vagrantfile provisioning script should set everything up. Keep in mind that some paths might need modifications (/vagrant directory won't exist, you might need to scp the required files, for example). Once the provisioning script has been run:

  1. MariaDB setup: Make a secure installation, import the database dump and flush privileges.
# mysql_secure_installation
# mysql -u root -p < /opt/clock-in_server/dbdump.sql
# mysql -u root -p -e "FLUSH PRIVILEGES"
  1. Add node_modules executables to PATH (for bunyan).
# echo "export PATH=\"$PATH:/opt/clock-in_server/node_modules/.bin/\"" >> ~/.bashrc
# source ~/.bashrc
  1. PM2 installation.
# npm install pm2 -g
  1. Remove SELinux. Modify /etc/sysconfig/selinux SELINUX variable to disabled.
# setenforce 0
# vim /etc/sysconfig/selinux
  1. Front-end application build. Move nginx.conf to /etc/nginx/nginx.conf, build the application and restart the server.
# cp /opt/clock-in_server/nginx.conf /etc/nginx/nginx.conf
# cd /var/www/html && ng build --prod
# systemctl restart nginx
  1. PM2 configuration (read documentation first). Run ecosystem, generate systemd unit block, save PM2 status for unit block.
# cd /opt/clock-in_server && pm2 start ecosystem.config.js --env production
# cp /opt/clock-in_server/pm2-root.service /etc/systemd/system/pm2-root.service
# pm2 save
  1. TCP Wrapper configuration.
# cp /opt/clock-in_server/hosts.* /etc/

At this point, both the front-end application and the back-end API should be running. The Angular application should be running in port 80 of your machine and the API in port 8080 (unless specified otherwise in /etc/nginx/nginx.conf or /opt/clock-in_server/index.js respectively). You can monitor the status of the API proccess running:

# pm2 monit

or

# pm2 ls

Error log is stored in /opt/clock-in_server/error.log and can be parsed using Bunyan:

# cat /opt/clock-in_server/error.log | /opt/clock-in_server/node_modules/.bin/bunyan

If you ever need to make any changes to the API code, you can run the following command to apply your changes with 0 downtime:

# pm2 reload /opt/clock-in_server/ecosystem.config.js --env production

Changes to Angular application are applied building the new code and restarting Nginx proccess:

# cd /var/www/html && ng build --prod
# systemctl restart nginx

Please remember to change your backend server IP in /var/www/html/src/app/network.service.ts before building

Please let me know if you find that something is missing.

Automatic database backup

In this section, we'll configure a cron task that will dump all information from our database to a SQL file. We'll also logrotate these backups, to remove old ones and we'll export the folder where these backups are being made, so we can back them up somewhere else too.

  1. Cron task. Copy the following to a file named "mysqldump" in "/etc/cron.daily/":
#!/bin/bash

/usr/bin/mysqldump --defaults-extra-file=/root/.mariadb_login.cnf -u root --single-transaction --quick --lock-tables=false --all-databases | tee /opt/clock-in_server/dbdump.sql > /root/dbbackup/full-backup-$(date +\%F).sql
/usr/sbin/logrotate /etc/logrotate.d/dbbackup

and edit "/root/.mariadblogin.cnf" to contain the following (change credentials to match your mariadb root credentials):

[client]
user = root
password = rootpass
  1. Logrotate. The first part is already done, as you can see in the daily cron task. We just need to make a configuration file named "/etc/logrotate.d/dbbackup" and fill it with:
/root/dbbackup/*.sql {
  daily
  rotate 5
  missingok
  compress
  postrotate
        /usr/bin/find /root/dbbackup -type f -size -1024c -exec rm {} \;
        /usr/bin/find /root/dbbackup -name "*.sql" -type f -mtime +7 -exec rm {} \;
        /usr/bin/find /root/dbbackup -name "*.gz" -type f -mtime +180 -exec rm {} \;
  endscript
  maxage 7
}
  1. NFS configuration.
# yum install nfs-utils -y
# chmod -R 755 /root/dbbackup
# chown nfsnobody:nfsnobody /root/dbbackup
# systemctl enable rpcbind
# systemctl enable nfs-server
# systemctl enable nfs-lock
# systemctl enable nfs-idmap
# systemctl start rpcbind
# systemctl start nfs-server
# systemctl start nfs-lock
# systemctl start nfs-idmap
# echo "/root/dbbackup  miscelanea-02.sw.ehu.es(ro,no_root_squash,no_subtree_check)" >> /etc/exports
# systemctl restart nfs-server
# firewall-cmd --permanent --zone=public --add-service=nfs
# firewall-cmd --permanent --zone=public --add-service=mountd
# firewall-cmd --permanent --zone=public --add-service=rpc-bind
# firewall-cmd --reload

Contributing

Any bug-fixes, improvements or other kinds of feedback are welcome. You can always open an issue in this project, make a pull request or even send me a personal email. Don't refrain from contacting me if you think I can help you with your installation :D.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the GNU GENERAL PUBLIC License - see the LICENSE file for details