Updated readme with social & update instructions

diff --git a/.env.example b/.env.example
index 91e59f9664c06d932cfce3dc70ca2bcc0fd86fe9..00d230bff4b06ebfaf3f860478b2e380ee61791d 100644 (file)
--- a/.env.example
+++ b/.env.example
@@ -7,7 +7,7 @@ APP_KEY=SomeRandomString
 DB_HOST=localhost
 DB_DATABASE=database_database
 DB_USERNAME=database_username
-DB_PASSWORD=database__user_password
+DB_PASSWORD=database_user_password
 
 # Cache and session
 CACHE_DRIVER=file
@@ -33,8 +33,8 @@ GOOGLE_APP_SECRET=false
 # URL used for social login redirects, NO TRAILING SLASH
 APP_URL=http://bookstack.dev
 
-# External services
-USE_GRAVATAR=true
+# External services such as Gravatar
+DISABLE_EXTERNAL_SERVICES=false
 
 # Mail settings
 MAIL_DRIVER=smtp
@@ -42,4 +42,4 @@ MAIL_HOST=localhost
 MAIL_PORT=1025
 MAIL_USERNAME=null
 MAIL_PASSWORD=null
-MAIL_ENCRYPTION=null
\ No newline at end of file
+MAIL_ENCRYPTION=null

diff --git a/app/Services/SocialAuthService.php b/app/Services/SocialAuthService.php
index c96446ddf67e4c519e0b48b57e2ce8e48685b54d..15fd1c6a2546eba367230ad830cab568b763dbd4 100644 (file)
--- a/app/Services/SocialAuthService.php
+++ b/app/Services/SocialAuthService.php
@@ -129,7 +129,7 @@ class SocialAuthService
         // When a user is logged in, A social account exists but the users do not match.
         // Change the user that the social account is assigned to.
         if ($isLoggedIn && $socialAccount !== null && $socialAccount->user->id != $currentUser->id) {
-            \Session::flash('success', 'This ' . title_case($socialDriver) . ' account is already used buy another user.');
+            \Session::flash('success', 'This ' . title_case($socialDriver) . ' account is already used by another user.');
             return redirect($currentUser->getEditUrl());
         }
 

diff --git a/readme.md b/readme.md
index 4073d171c24cf23ef9e0c964f20cd7b61e6e3ec9..1a429369bb00e5a88f4fe4cb7a0b232312d14c5b 100644 (file)
--- a/readme.md
+++ b/readme.md
@@ -61,6 +61,41 @@ location / {
     try_files $uri $uri/ /index.php?$query_string;
 }
 ```
+## Updating BookStack
+
+To update BookStack you can run the following command in the root directory of the application:
+```
+git pull origin release && composer install && php artisan migrate
+```
+This command will update the repository that was created in the installation, install the PHP dependencies using `composer` then run the database migrations. 
+
+## Social Authentication
+
+BookStack currently supports login via both Google and Github. Once enabled options for these services will show up in the login, registration and user profile pages. By default these services are disabled. To enable them you will have to create an application on the external services to obtain the require application id's and secrets. Here are instructions to do this for the current supported services:
+
+### Google
+
+1. Open the [Google Developers Console](https://console.developers.google.com/).
+2. Create a new project (May have to wait a short while for it to be created).
+3. Select 'Enable and manage APIs'.
+4. Enable the 'Google+ API'.
+5. In 'Credentials' choose the 'OAuth consent screen' tab and enter a product name ('BookStack' or your custom set name).
+6. Back in the 'Credentials' tab click 'New credentials' > 'OAuth client ID'.
+7. Choose an application type of 'Web application' and enter the following urls under 'Authorized redirect URIs', changing `https://example.com` to your own domain where BookStack is hosted:
+    - `https://example.com/login/service/google/callback`
+    - `https://example.com/register/service/google/callback`
+8. Click 'Create' and your app_id and secret will be displayed. Replace the false value on both the `GOOGLE_APP_ID` & `GOOGLE_APP_SECRET` variables in the '.env' file in the BookStack root directory with your own app_id and secret.
+9. Set the 'APP_URL' environment variable to be the same domain as you entered in step 7. So, in this example, it will be `https://example.com`.
+10. All done! Users should now be able to link to their social accounts in their account profile pages and also register/login using their Google accounts.
+
+### Github
+
+1. While logged in, open up your [GitHub developer applications](https://github.com/settings/developers).
+2. Click 'Register new application'.
+3. Enter an application name ('BookStack' or your custom set name), A link to your app instance under 'Homepage URL' and an 'Authorization callback URL' of the url that your BookStack instance is hosted on then click 'Register application'.
+4. A 'Client ID' and a 'Client Secret' value will be shown. Add these two values to the to the `GITHUB_APP_ID` and `GITHUB_APP_SECRET` variables, replacing the default false value, in the '.env' file found in the BookStack root folder.
+5. Set the 'APP_URL' environment variable to be the same domain as you entered in step 3.
+6. All done! Users should now be able to link to their social accounts in their account profile pages and also register/login using their Github account.
 
 ## Testing
 
@@ -73,7 +108,7 @@ php artisan migrate --database=mysql_testing
 php artisan db:seed --class=DummyContentSeeder --database=mysql_testing
 ```
 
-Once done you can run `phpunit` in the application root directory to run all tests.
+Once done you can run `phpunit` (or `./vendor/bin/phpunit` if `phpunit` is not found) in the application root directory to run all tests.
 
 ## License