From 1f4e21a65a759cb8322c5f5c1e02f858750c48f7 Mon Sep 17 00:00:00 2001 From: Bubka <858858+Bubka@users.noreply.github.com> Date: Mon, 30 Mar 2020 09:45:28 +0200 Subject: [PATCH] Update README.md --- README.md | 39 ++++++++++++++++++++++++++++----------- 1 file changed, 28 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 93266b79..5ef15d72 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,10 @@ # 2FAuth ![screens](https://user-images.githubusercontent.com/858858/74479269-267a1600-4eaf-11ea-9281-415e5a54bd9f.png) +#### [2FAuth Demo](https://demo.2fauth.app/) + +Credentials (login - password) : *demo@2fauth.app* - *demo* + ## Purpose 2FAuth is a web based self-hosted alternative to One Time Passcode (OTP) generators like Google Authenticator that you can use both on mobile or desktop. @@ -46,9 +50,14 @@ #### Install all php dependencies ``` Don't have `composer`? [you can get it here](https://getcomposer.org/download/) -#### Set your variables -In your installation directory make a copy of the `.env.example` file and rename the copy `.env`. +#### Set up your database +Create a database with one of the supported tools (see Requirements). +For SQLite, place the database `.sqlite` file in the `database/` folder of your 2FAuth installation. + +#### Set your variables + +In your installation directory make a copy of the `.env.example` file and rename the copy `.env`. Edit the `.env` file and adapt the settings to your running environment (see instructions in the file) #### Prepare some stuff @@ -59,17 +68,25 @@ #### Prepare some stuff php artisan config:cache php artisan vue-i18n:generate ``` - -#### Install js dependencies -``` -npm install -``` - -#### Build -`npm run dev` or `npm run prod` - You are ready to go. +#### For development only +Install and build js dependencies +``` +npm install +npm run dev +``` + +## Update your installation +First, **backup your database**. + +Then, using command line : +``` +git pull +php composer.phar install +php artisan migrate +php artisan config:clear +``` # Contributing to complete