Add Auth0, partial support
This commit is contained in:
@@ -0,0 +1,99 @@
|
||||
<?php declare(strict_types=1);
|
||||
|
||||
require '../start.php';
|
||||
|
||||
page_head('Documentation'); ?>
|
||||
<article class="container mt-3">
|
||||
<h2 class=mb-3>Documentation</h2>
|
||||
|
||||
<h3 class="mb-3 mt-4">About myPrayerJournal</h3>
|
||||
<p>Journaling has a long history; it helps people remember what happened, and the act of writing helps people think
|
||||
about what happened and process it. A prayer journal is not a new concept; it helps you keep track of the
|
||||
requests for which you’ve prayed, you can use it to pray over things repeatedly, and you can write the
|
||||
result when the answer comes <em>(or it was “no”)</em>.
|
||||
<p>myPrayerJournal was borne of out of a personal desire
|
||||
<a href=https://daniel.summershome.org target=_blank rel=noopener>Daniel</a> had to have something that would
|
||||
help him with his prayer life. When it’s time to pray, it’s not really time to use an app, so the
|
||||
design goal here is to keep it simple and unobtrusive. It will also help eliminate some of the downsides to a
|
||||
paper prayer journal, like not remembering whether you’ve prayed for a request, or running out of room to
|
||||
write another update on one.
|
||||
|
||||
<h3 class="mb-3 mt-4">Signing Up</h3>
|
||||
<p>myPrayerJournal uses login services using Google or Microsoft accounts. The only information the application
|
||||
stores in its database is your user ID token it receives from these services, so there are no permissions you
|
||||
should have to accept from these provider other than establishing that you can log on with that account. Because
|
||||
of this, you’ll want to pick the same one each time; the tokens between the two accounts are different,
|
||||
even if you use the same e-mail address to log on to both.
|
||||
|
||||
<h3 class="mb-3 mt-4">Your Prayer Journal</h3>
|
||||
<p>Your current requests will be presented in columns (usually three, but it could be more or less, depending on the
|
||||
size of your screen or device). Each request is in its own card, and the buttons at the top of each card apply
|
||||
to that request. The last line of each request also tells you how long it has been since anything has been done
|
||||
on that request. Any time you see something like “a few minutes ago,” you can hover over that to see
|
||||
the actual date/time the action was taken.
|
||||
|
||||
<h3 class="mb-3 mt-4">Adding a Request</h3>
|
||||
<p>To add a request, click the “Add a New Request” button at the top of your journal. Then, enter the
|
||||
text of the request as you see fit; there is no right or wrong way, and you are the only person who will see the
|
||||
text you enter. When you save the request, it will go to the bottom of the list of requests.
|
||||
|
||||
<h3 class="mb-3 mt-4">Setting Request Recurrence</h3>
|
||||
<p>When you add or update a request, you can choose whether requests go to the bottom of the journal once they have
|
||||
been marked “Prayed” or whether they will reappear after a delay. You can set recurrence in terms of
|
||||
hours, days, or weeks, but it cannot be longer than 365 days. If you decide you want a request to reappear
|
||||
sooner, you can skip the current delay; click the “Active” menu link, find the request in the list
|
||||
(likely near the bottom), and click the “Show Now” button.
|
||||
|
||||
<h3 class="mb-3 mt-4">Praying for Requests</h3>
|
||||
<p>The first button for each request has a checkmark icon; clicking this button will mark the request as
|
||||
“Prayed” and move it to the bottom of the list (or off, if you’ve set a recurrence period for
|
||||
the request). This allows you, if you’re praying through your requests, to start at the top left (with the
|
||||
request that it’s been the longest since you’ve prayed) and click the button as you pray; when the
|
||||
request move below or away, the next-least-recently-prayed request will take the top spot.
|
||||
|
||||
<h3 class="mb-3 mt-4">Editing Requests</h3>
|
||||
<p>The second button for each request has a pencil icon. This allows you to edit the text of the request, pretty
|
||||
much the same way you entered it; it starts with the current text, and you can add to it, modify it, or
|
||||
completely replace it. By default, updates will go in with an “Updated” status; you have the option
|
||||
to also mark this update as “Prayed” or “Answered”. Answered requests will drop off the
|
||||
journal list.
|
||||
|
||||
<h3 class="mb-3 mt-4">Adding Notes</h3>
|
||||
<p>The third button for each request has an icon that looks like a speech bubble with lines on it; this lets you
|
||||
record notes about the request. If there is something you want to record that doesn’t change the text of
|
||||
the request, this is the place to do it. For example, you may be praying for a long-term health issue, and that
|
||||
person tells you that their status is the same; or, you may want to record something God said to you while you
|
||||
were praying for that request."
|
||||
|
||||
<h3 class="mb-3 mt-4">Snoozing Requests</h3>
|
||||
<p>There may be a time when a request does not need to appear. The fourth button, with the clock icon, allows you to
|
||||
snooze requests until the day you specify. Additionally, if you have any snoozed requests, a
|
||||
“Snoozed” menu item will appear next to the “Journal” one; this page allows you to see
|
||||
what requests are snoozed, and return them to your journal by canceling the snooze.
|
||||
|
||||
<h3 class="mb-3 mt-4">Viewing a Request and Its History</h3>
|
||||
<p>myPrayerJournal tracks all actions related to a request; from the “Active” and “Answered”
|
||||
menu links (and “Snoozed”, if it’s showing), there is a “View Full Request”
|
||||
button. That page will show the current text of the request; how many times it has been marked as prayed; how
|
||||
long it has been an active request; and a log of all updates, prayers, and notes you have recorded. That log is
|
||||
listed from most recent to least recent; if you want to read it chronologically, press the “End” key
|
||||
on your keyboard and read it from the bottom up.
|
||||
<p>The “Active” link will show all requests that have not yet been marked answered, including snoozed
|
||||
and recurring requests. If requests are snoozed, or in a recurrence period off the journal, there will be a
|
||||
button where you can return the request to the list (either “Cancel Snooze” or “Show
|
||||
Now”). The “Answered” link shows all requests that have been marked answered. The
|
||||
“Snoozed” link only shows snoozed requests.
|
||||
|
||||
<h3 class="mb-3 mt-4">Final Notes</h3>
|
||||
<ul>
|
||||
<li>If you encounter errors, please
|
||||
<a href=https://git.bitbadger.solutions/bit-badger/myPrayerJournal/issues target=_blank rel=noopener>file an
|
||||
issue</a> (or <a href="mailto:daniel@bitbadger.solutions?subject=myPrayerJournal+Issue">e-mail Daniel</a> if
|
||||
you do not have an account on that server) with as much detail as possible. You can also provide
|
||||
suggestions, or browse the list of currently open issues.
|
||||
<li>Prayer requests and their history are securely backed up nightly along with other Bit Badger Solutions data.
|
||||
<li>Prayer changes things - most of all, the one doing the praying. I pray that this tool enables you to deepen
|
||||
and strengthen your prayer life.
|
||||
</ul>
|
||||
</article><?php
|
||||
page_foot();
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
require '../start.php';
|
||||
|
||||
html_head('Welcome'); ?>
|
||||
page_head('Welcome'); ?>
|
||||
<article class="container mt-3">
|
||||
<p>
|
||||
<p>myPrayerJournal is a place where individuals can record their prayer requests, record that they prayed for them,
|
||||
@@ -12,4 +12,4 @@ html_head('Welcome'); ?>
|
||||
On” link above, and log on with either a Microsoft or Google account. You can also learn more about the
|
||||
site at the “Docs” link, also above.
|
||||
</article><?php
|
||||
html_foot();
|
||||
page_foot();
|
||||
|
||||
@@ -0,0 +1,69 @@
|
||||
<?php declare(strict_types=1);
|
||||
|
||||
require '../../start.php';
|
||||
|
||||
page_head('Privacy Policy'); ?>
|
||||
<article class="container mt-3">
|
||||
<h2 class=mb-2>Privacy Policy</h2>
|
||||
<h6 class="text-muted pb-3">as of May 21<sup>st</sup>, 2018</h6>
|
||||
<p>The nature of the service is one where privacy is a must. The items below will help you understand the data we
|
||||
collect, access, and store on your behalf as you use this service.
|
||||
<div class=card>
|
||||
<div class="list-group list-group-flush">
|
||||
<div class=list-group-item>
|
||||
<h3>Third Party Services</h3>
|
||||
<p class=card-text>
|
||||
myPrayerJournal utilizes a third-party authentication and identity provider. You should familiarize
|
||||
yourself with the privacy policy for
|
||||
<a href=https://auth0.com/privacy target=_blank rel=noopener>Auth0</a>, as well as your chosen
|
||||
provider
|
||||
(<a href=https://privacy.microsoft.com/en-us/privacystatement target=_blank rel=noopener>Microsoft</a>
|
||||
or <a href=https://policies.google.com/privacy target=_blank rel=noopener>Google</a>).
|
||||
</div>
|
||||
<div class=list-group-item>
|
||||
<h3>What We Collect</h3>
|
||||
<h4>Identifying Data</h4>
|
||||
<ul>
|
||||
<li>The only identifying data myPrayerJournal stores is the subscriber (“sub”) field
|
||||
from the token we receive from Auth0, once you have signed in through their hosted service. All
|
||||
information is associated with you via this field.
|
||||
<li>While you are signed in, within your browser, the service has access to your first and last
|
||||
names, along with a URL to the profile picture (provided by your selected identity provider).
|
||||
This information is not transmitted to the server, and is removed when “Log Off” is
|
||||
clicked.
|
||||
</ul>
|
||||
<h4>User Provided Data</h4>
|
||||
<ul class=mb-0>
|
||||
<li>myPrayerJournal stores the information you provide, including the text of prayer requests,
|
||||
updates, and notes; and the date/time when certain actions are taken.
|
||||
</ul>
|
||||
</div>
|
||||
<div class=list-group-item>
|
||||
<h3>How Your Data Is Accessed / Secured</h3>
|
||||
<ul class=mb-0>
|
||||
<li>Your provided data is returned to you, as required, to display your journal or your answered
|
||||
requests. On the server, it is stored in a controlled-access database.
|
||||
<li>Your data is backed up, along with other Bit Badger Solutions hosted systems, in a rolling
|
||||
manner; backups are preserved for the prior 7 days, and backups from the 1<sup>st</sup> and
|
||||
15<sup>th</sup> are preserved for 3 months. These backups are stored in a private cloud data
|
||||
repository.
|
||||
<li>The data collected and stored is the absolute minimum necessary for the functionality of the
|
||||
service. There are no plans to “monetize” this service, and storing the minimum
|
||||
amount of information means that the data we have is not interesting to purchasers (or those who
|
||||
may have more nefarious purposes).
|
||||
<li>Access to servers and backups is strictly controlled and monitored for unauthorized access
|
||||
attempts.
|
||||
</ul>
|
||||
</div>
|
||||
<div class=list-group-item>
|
||||
<h3>Removing Your Data</h3>
|
||||
<p class=card-text>
|
||||
At any time, you may choose to discontinue using this service. Both Microsoft and Google provide
|
||||
ways to revoke access from this application. However, if you want your data removed from the
|
||||
database, please contact daniel at bitbadger.solutions (via e-mail, replacing at with @) prior to
|
||||
doing so, to ensure we can determine which subscriber ID belongs to you.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article><?php
|
||||
page_foot();
|
||||
@@ -0,0 +1,55 @@
|
||||
<?php declare(strict_types=1);
|
||||
|
||||
require '../../start.php';
|
||||
|
||||
page_head('Terms of Service'); ?>
|
||||
<article class="container mt-3">
|
||||
<h2 class=mb-2>Terms of Service</h2>
|
||||
<h6 class="text-muted pb-3">as of May 21<sup>st</sup>, 2018</h6>
|
||||
<div class=card>
|
||||
<div class="list-group list-group-flush">
|
||||
<div class=list-group-item>
|
||||
<h3>1. Acceptance of Terms</h3>
|
||||
<p class=card-text>
|
||||
By accessing this web site, you are agreeing to be bound by these Terms and Conditions, and that you
|
||||
are responsible to ensure that your use of this site complies with all applicable laws. Your
|
||||
continued use of this site implies your acceptance of these terms.
|
||||
</div>
|
||||
<div class=list-group-item>
|
||||
<h3>2. Description of Service and Registration</h3>
|
||||
<p class=card-text>
|
||||
myPrayerJournal is a service that allows individuals to enter and amend their prayer requests. It
|
||||
requires no registration by itself, but access is granted based on a successful login with an
|
||||
external identity provider. See <?php page_link('/legal/privacy-policy', 'our privacy policy'); ?>
|
||||
for details on how that information is accessed and stored.
|
||||
</div>
|
||||
<div class=list-group-item>
|
||||
<h3>3. Third Party Services</h3>
|
||||
<p class=card-text>
|
||||
This service utilizes a third-party service provider for identity management. Review the terms of
|
||||
service for <a href=https://auth0.com/terms target=_blank rel=noopener>Auth0</a>, as well as those
|
||||
for the selected authorization provider
|
||||
(<a href=https://www.microsoft.com/en-us/servicesagreement target=_blank rel=noopener>Microsoft</a>
|
||||
or <a href=https://policies.google.com/terms target=_blank rel=noopener>Google</a>).
|
||||
</div>
|
||||
<div class=list-group-item>
|
||||
<h3>4. Liability</h3>
|
||||
<p class=card-text>
|
||||
This service is provided “as is”, and no warranty (express or implied) exists. The
|
||||
service and its developers may not be held liable for any damages that may arise through the use of
|
||||
this service.
|
||||
</div>
|
||||
<div class=list-group-item>
|
||||
<h3>5. Updates to Terms</h3>
|
||||
<p class=card-text>
|
||||
These terms and conditions may be updated at any time, and this service does not have the capability
|
||||
to notify users when these change. The date at the top of the page will be updated when any of the
|
||||
text of these terms is updated."
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<p class=pt-3>
|
||||
You may also wish to review our <?php page_link('/legal/privacy-policy', 'privacy policy'); ?> to learn how we
|
||||
handle your data.
|
||||
</article><?php
|
||||
page_foot();
|
||||
@@ -0,0 +1,7 @@
|
||||
<?php declare(strict_types=1);
|
||||
|
||||
use MyPrayerJournal\Auth;
|
||||
|
||||
require '../../start.php';
|
||||
|
||||
Auth::logOff();
|
||||
@@ -0,0 +1,7 @@
|
||||
<?php declare(strict_types=1);
|
||||
|
||||
use MyPrayerJournal\Auth;
|
||||
|
||||
require '../../start.php';
|
||||
|
||||
Auth::logOn();
|
||||
@@ -0,0 +1,11 @@
|
||||
<?php declare(strict_types=1);
|
||||
|
||||
use MyPrayerJournal\Auth;
|
||||
|
||||
require '../../../start.php';
|
||||
|
||||
Auth::client()->exchange($_ENV['AUTH0_BASE_URL'] . '/user/log-on/success');
|
||||
|
||||
// TODO: get the possible redirect URL
|
||||
header('Location: /');
|
||||
exit();
|
||||
Reference in New Issue
Block a user