mirror of
https://github.com/Bubka/2FAuth.git
synced 2025-02-02 11:39:19 +01:00
Update README.md
This commit is contained in:
parent
bfa1f43ba8
commit
1f4e21a65a
39
README.md
39
README.md
@ -8,6 +8,10 @@ # 2FAuth
|
|||||||
|
|
||||||
![screens](https://user-images.githubusercontent.com/858858/74479269-267a1600-4eaf-11ea-9281-415e5a54bd9f.png)
|
![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
|
## 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.
|
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/)
|
Don't have `composer`? [you can get it here](https://getcomposer.org/download/)
|
||||||
|
|
||||||
#### Set your variables
|
#### Set up your database
|
||||||
In your installation directory make a copy of the `.env.example` file and rename the copy `.env`.
|
|
||||||
|
|
||||||
|
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)
|
Edit the `.env` file and adapt the settings to your running environment (see instructions in the file)
|
||||||
|
|
||||||
#### Prepare some stuff
|
#### Prepare some stuff
|
||||||
@ -59,17 +68,25 @@ #### Prepare some stuff
|
|||||||
php artisan config:cache
|
php artisan config:cache
|
||||||
php artisan vue-i18n:generate
|
php artisan vue-i18n:generate
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Install js dependencies
|
|
||||||
```
|
|
||||||
npm install
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Build
|
|
||||||
`npm run dev` or `npm run prod`
|
|
||||||
|
|
||||||
You are ready to go.
|
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
|
# Contributing
|
||||||
to complete
|
to complete
|
||||||
|
Loading…
Reference in New Issue
Block a user