Giter Club home page Giter Club logo

firefly-iii-gulp's Introduction

Scripts for Firefly III

This repository contains useful scripts for the orchestration of a firefly iii instance. Feel free to use the gulp tasks for your personal application.

Getting Started

  1. Install via yarn
  2. Create a .envfile in the root of this repository with the following content:
  # SSH Connection Information
  SSH_HOST=<your server IP>
  SSH_USER=<SSH user>V
  SSH_PW=<SSH user password>
  SSH_PORT=<SSH port > # optional (default: 22)

  # DB Connection Information
  DB_USER=<database user>
  DB_PW=<database user password>
  DB_HOST=<host of DB> # optional (default: localhost)
  DB_NAME=<database name>

  # Custom Project Information
  FIREFLY_PATH=<path to your firefly app> # (e.g. /var/wwww/firefly-iii)
  BACKUP_PATH=<path to your local folder for backups> 

Backup

gulp backup

Performs a backup of all relevant files of your firefly iii application as follows:

  • Creates a new folder for your backup in XXX
  • Copies .env of your firefly application
  • Creates a SQL dump and moves it to storage/database
  • Copies /storage/database and storage/uploads to the backup folder

Restore

gulp restore

Restores files and database from backup at remote server:

  • Selects desired backup to restore via prompt
  • Copies .env to your firefly application
  • Copies database folder to /storage/database
  • Copies upload folder to /storage/upload
  • Restores database
  • Deletes database dump remotely

Upgrade

Firefly III

gulp upgrade

Upgrades your firefly iii version to the newest one:

  • Deletes /var/www/<your-app>-old folder
  • Installs newest version in /var/www/<your-app>-updated
  • Renames current /var/www/<your-app> to /var/www/<your-app>-old
  • Renames new /var/www/<your-app>-updated to /var/www/<your-app>
  • Updates folder permissions accordingly
  • Restars apache server

Shoutout to @pedrom34 and his gist

Data-Importer

gulp upgrade-importer

  • Installs newest version in /var/www/updated-data-importer
  • Copies the current .env in the updated version
  • Moves the current data importer to /var/www/old-data-importer
  • Moves the updated data importer to /var/www/data-importer
  • Updates folder permissions accordingly

firefly-iii-gulp's People

Contributors

sidyes avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.