=== Buoy ===
Contributors: meitar
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=TJLPJYXHSRBEE&lc=US&item_name=Better%20Angels%20Buoy&item_number=Better%20Angels%20Buoy&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted
Tags: community, emergency response, activism
Requires at least: 4.6
Tested up to: 4.7
Stable tag: 0.3.3
License: GPL-3
License URI: https://www.gnu.org/licenses/gpl-3.0.html

A community-based crisis response system. Buoy is a private, enhanced, cop-free alternative to 112 or 911.

== Description ==

Buoy is a decentralized 9-1-1 alternative built for and by people who are not well served by existing emergency response services. Buoy makes it easy to tell your friends where you are and what you need. Buoy's goal is a world where anyone in distress always has the option to turn to people they trust for support, rather than being forced to rely on people they don't.

Buoy is not a traditional "app" that you can download in the app store, but rather a system for adding crisis response and emergency dispatch services to existing websites. With Buoy, community groups, activist organizations, and social support service providers can quickly connect people who need help with trusted friends, family members, advocates, and other allies who can help them. It is designed to be community owned and operated, so each instance of Buoy can be customized to the unique needs or the organization or community group that hosts it.

Whether you are a group of street medics coordinating with each other during an action, citizen journalists or copwatchers watching each other's backs, domestic violence survivor support advocates, or even single parents picking each others’ kids up from school, Buoy helps you get and give peer-based mutual aid to your friends and comrades.

*For service providers*

Anyone with a WordPress-powered website or blog can add the Buoy software (a 1-click automatic install) to their website, enabling the site's membership to provide peer-based mutual-aid to one another. Moreover, legal aid service providers, domestic, dating, and intimate partner violence prevention advocates, shelters, social groups, alternative medical and mental health collectives, and others can offer members of their community one-click emergency access to a network of trusted peers and/or on-call emergency responders.

*For victims and survivors*

Buoy makes it easy to tell your friends where you are and what you need, even in the most dangerous or frightening scenarios. Tapping a single button will immediately notify the people you trust most that you need their help, give them a map showing your exact location, and even helps them coordinate with one another to quickly figure out how to help you best. With Buoy and a smartphone, you are never more than one button press away from the people you trust most. (We are even working to support old-school flipfones!)

You do not need to download or install special software to use Buoy. Simply bookmark a page with your smartphone's built-in Web browser to gain instant access to your personal emergency response team. Quickly send them your location with a pre-defined custom message, write a custom message, or schedule a timed alert (like a "safe call") for some time in the future.

The people you select as your emergency contacts ("response team") will get a notification showing them your location in the real world as well as the locations of any other responders to your call for help. If it's safe for you to do so, you can now coordinate with all responders in a live chat room, or responders can coordinate amongst themselves about how best to help you if you are unresponsive.

**See the [screenshots](https://wordpress.org/plugins/buoy/screenshots/) for an example walkthrough of how Buoy works.**

[Find a Buoy-enabled web site.](https://github.com/betterangels/buoy/wiki/List-of-Buoy-enabled-websites)

== Installation ==

Buoy can be installed automatically from the WordPress plugin repository by searching for "Buoy" in the "Add new plugin" screen of your WordPress admin site and clicking the "Install now" button.

Buoy can also be installed manually by following these instructions:

1. [Download the latest plugin code](https://downloads.wordpress.org/plugin/buoy.zip) from the WordPress plugin repository.
1. Upload the unzipped `buoy` folder to the `/wp-content/plugins/` directory of your WordPress installation.
1. Activate the plugin through the 'Plugins' menu in WordPress.

Once activated, each user who wants to use Buoy must define their personal response team (list their chosen emergency contacts) in the "My Team" settings page before they can actually send an alert. See the [screenshots](https://wordpress.org/plugins/buoy/screenshots/) for a brief walkthrough of how to configure Buoy after it is installed.

Read the [Buoy Administration Guide](https://github.com/betterangels/buoy/wiki/Administrator-documentation) for more information on how to administer a Buoy for your community.

= Installation notes and troubleshooting =

If you are having trouble installing Buoy, make sure the computer hosting your website meets the following minimum requirements:

* PHP 5.3 or greater is installed.
* You have installed or updated to the version of WordPress mentioned in the **Requires** field of this file.

== Frequently Asked Questions ==

Read [the full FAQ](https://github.com/betterangels/buoy/wiki/Frequently-Asked-Questions) on our wiki. Below is a subset of the most common questions we get about Buoy.

= Where do I get Buoy? I don't see it in the app store. =

Buoy is not an app, it is a tool that adds emergency dispatch services to websites. To use Buoy, you must have a user account on some community-run website, such as those provided by addiction recovery support groups, domestic violence shelters, local volunteer medical collectives, or similar.

If you don't know of any such groups, take a look through our [List of Buoy-enabled websites](https://github.com/betterangels/buoy/wiki/List-of-Buoy-enabled-websites). Maybe there's a group near you!

If not, consider starting such a group in your town. Reach out to collectives such as [Cop Watch](http://wecopwatch.org/), a local legal aid service provider, [Critical Resistance](http://criticalresistance.org/), [SMART Recovery](http://smartrecovery.org/), the [NCADV](http://www.ncadv.org/), the [Black Cross Health Collective](http://www.blackcrosscollective.org/), or other similar organizations and ask them how you can start a chapter in your neighborhood.

Then get in touch with the [Better Angels](https://betterangels.github.io/) (that's us!) and we'll help you install and set up Buoy for your community.

= Does Buoy track my location? =

No. Buoy never tracks or record your movements. The only time Buoy knows where you are is when you press the emergency alert button. Buoy then sends this information only to the people you added to your emergency response team.

= Should I only use Buoy in a real emergency? =

Although Buoy is designed to be useful in even the most phsyically high-risk situations such as domestic or dating violence abuses, kidnapping, home invasion, and other frightening scenarios, you can use Buoy however you want. We particularly encourage you to use Buoy when you feel like your situation may not rise to the level of calling 9-1-1 or when you feel like the presence of police officers will not improve the situation.

For instance:

* If you feel you are being followed as you walk home on campus, use Buoy. Your friends will be able to watch your location on their screens and quietly chat with you as you walk home, ensuring you reach your destination safely.
* If you or someone you are with feels suicidal, or has a bad trip, and you don't want cops showing up to your house but need assistance, use Buoy. Responders will be notified of your physical location and will be able to coordinate a response action with you and with each-other in real time without ever notifying the authorities of the situation.
* If you are with a group at an outing such as a hike or a large amusement park and get separated from your group, use Buoy. Each group member will be able to see one another's current location on a map, can easily coordinate where to meet up, and can even access turn-by-turn directions to one another's locations with one tap of your finger.

== Screenshots ==

1. After installing and activating Buoy, each user can create one or more crisis response teams by selecting the "My Team" heading in the WordPress dashboard menu. The first team you create is your default team. This page shows an overview of your team(s), and includes information like how many people are on it, and whether or not it is defined as your default team. You can create teams for any purpose, including long-lived community support groups like volunteer fire or medical brigades, organized [CopWatch](https://www.thenation.com/article/heres-how-to-cop-watch/), or short-lived affinity groups for a single protest action.

2. Once you make a team, you can add or remove users from it. When you add a user, they receive an email notification inviting them to join your team (see next screenshot). Your team detail page shows a list of all the users who have accepted your invitation ("confirmed") as well as the users you have invited but have not yet joined. You can also invite new users by entering an email address instead of a username, in which case they will receive a friendly sign-up invitation to create an account on the Buoy.

3. When you are invited to join someone's response team, you receive an email with a link to the "Team Membership" page, shown here. On this page you can accept another user's invitation to join their team or leave the teams you have previously joined.

4. After at least one person accepts your invitation to join one of your response teams (i.e., they have opted-in to being one of your emergency contacts), you can access the Buoy emergency alert screen. This screen is accessed from the "New Content" (+) button in the admin toolbar, across the top of the screen. You can bookmark this page and add it to your phone's home screen so you can launch Buoy the same way you would launch any other app you installed from the app store. Pressing the large button nearest the bottom of the screen activates an alert and immediately sends notifications to your default response team.

5. Clicking on the smaller button with the chat bubble icon on it opens the custom alert dialog. Use this button to provide additional context about your situation that will be sent as part of the notification responders receive, or to send an alert to one or more teams other than your default one.

6. Clicking on the smaller button with the clock icon on it opens the timed alert ("safe call") dialog. Use this button to schedule an alert to be sent some time in the future. This way you can alert your response team to an emergency in the event that you are unable to *cancel* the alert. This is especially useful for bad dates.

7. Regardless of which alert option you select, Buoy will gather some information from your device (including your location and your alert message) and either send your alert to your response team(s) immediately or schedule the alert with the Buoy server.

8. If you pressed one of the immediate alert buttons, you will be shown [safety information written by your Buoy's administrator](https://github.com/betterangels/buoy/wiki/Configure). If it is safe to do so, you can read through this information and/or take one of the suggested actions immediately. Otherwise, you can simply ignore this screen. As long as you keep your device with you, your response team will be able to find you thanks to its GPS or other location-aware beacon.

9. You can also close the safety information window at any time. When you do, you will see that behind the safety information window, a private, temporary chat room has been loaded in the background. When one of your team members responds to your alert, they will join you in this chat room. (Buoy ships with a built-in chat room and integrates with some third-party chat room providers.) This chat room also provides the ability for responders to upload media and record video or audio, and immediately share that media with other responders. Further, if your phone is destroyed or confiscated during an incident, a copy of the media you uploaded will still be saved on your Buoy's server, in a remote, safer location. (This is especially useful for CopWatch scenarios since police officers are notorious for illegally seizing cell phones and deleting footage.)

10. In addition to the chat room, behind the safety information window is also a real-time map. (The map can be accessed at any time by clicking or tapping the "Show Map" button. Tapping the same button again hides the map.) On the map, a red pin shows the initial location of the device that sent out the alert. Your profile's gravatar shows your current position. As responders respond to your alert, their gravatars will also be added to the map.

11. When a responder clicks on a notification from the alert you sent (either by email, SMS/txt message, or whatever other notification mechanism they prefer), they will be shown your alert message along with a map. They can click on the red pin to get turn-by-turn directions from their current location to the emergency alert signal. If they choose to respond, they click on the "Respond" button and will automatically be added to the group chat shown earlier.

12. When a responder clicks the "Respond" button, they will automatically be added to the same live chat room that the alerter is in. They will also see the same map.

13. The alerter and all current responders become aware of new responders as they are added to the chat room and the map. As people involved in the incident move in the physical world, the map shown to each of the other people also updates in near real time. Clicking on any of the user icons on the map reveals one-click access to both turn-by-turn directions to their location and one-click access to call them from your phone, Facetime, Skype, or other default calling app.

== Change log ==

= 0.3.3 =

* Bugfixes: Various bugs with the built-in chat system have been fixed.
* Localization: Improved translations for Spanish dialects.
* Compatibility with WordPress 4.7.

= 0.3.2 =

* [Bugfix](https://wordpress.org/support/topic/fatal-error-on-install-19/): Hot fix for fatal error on some install attempts.

= 0.3.1 =

* Add SMS support for The People's Operator mobile phone SMS provider.
* Threading improvements when receiving SMS/txt messages.
* Minor bug fixes.

= 0.3.0 =

* [Feature](https://github.com/betterangels/buoy/wiki/Team-SMS-txt-broadcast-channel): Always-on SMS/txt broadcast channel for confirmed Team members.
* Numerous minor bug fixes.

= 0.2.0 =

This is a feature, bugfix, and security release. Please update your Buoy as soon as you can.

In this release:

* Privacy: Replace Google Maps with OpenStreetMaps. With this change, Buoy no longer relies on any non-free (proprietary) code.
* Feature: Chat rooms now support videoconferencing and live-streaming courtesy [Jitsi Meet](https://meet.jit.si/).
* [Feature](https://github.com/meitar/better-angels/issues/115): Multiple default teams are now supported.
    * You can now set more than one team as your "default." These are teams whose members will be sent notifications when you press the big red Alert button. Setting a list of teams as your default instead of just one gives you more flexibility in what the Immediate Alert button does.
* Usability: New users automatically have three (empty) teams created for them when they sign up.
* Many bugfixes and additional performance improvements.

= 0.1.2 =

This is a bugfix and maintenance release.

* New translations for Spanish, partial translations for German. To help translate Buoy into your language, [join our translation teams](https://www.transifex.com/cyberbusking/better-angels/).
* [Bugfix](https://github.com/meitar/better-angels/issues/131): Tlk.io chat room is no longer vertically scrunched.

= 0.1.1 =

This is a bugfix and maintenance release.

* [Bugfix](https://github.com/meitar/better-angels/issues/119): Work around `Fatal error` when accessing [Theme Customizer](https://codex.wordpress.org/Appearance_Customize_Screen) on some installs.
* [Bugfix](https://github.com/meitar/better-angels/issues/120): Fatal error during uninstallation.
* [Bugfix](https://github.com/meitar/better-angels/issues/121): Drop-down of available crisis responders produced incorrect autocomplete output.
* [Bugfix](https://github.com/meitar/better-angels/issues/129): Automatically show map if it is hidden when activating a mapping sub-menu item.
* [Bugfix](https://github.com/meitar/better-angels/issues/135): "Go to my location" button pans to correct user when viewing incident map.

= 0.1 =

* Initial prototype.

== Upgrade Notice ==

= 0.3.1 =

This is a maintenance and bugfix release, adding SMS support for another mobile carrier and improving txt message usability.

= 0.3.0 =

This is a major feature release. It adds an always-on SMS chat room for each Team and fixes many minor bugs.

== Other notes ==

If you like this plugin, **please consider [making a donation](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=meitarm%40gmail%2ecom&lc=US&item_name=Inline%20Google%20Spreadsheet%20Viewer%20WordPress%20Plugin&item_number=inline%2dgdocs%2dviewer&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted) for your use of the plugin**, [purchasing one of Meitar's web development books](http://www.amazon.com/gp/redirect.html?ie=UTF8&location=http%3A%2F%2Fwww.amazon.com%2Fs%3Fie%3DUTF8%26redirect%3Dtrue%26sort%3Drelevancerank%26search-type%3Dss%26index%3Dbooks%26ref%3Dntt%255Fathr%255Fdp%255Fsr%255F2%26field-author%3DMeitar%2520Moscovitz&tag=maymaydotnet-20&linkCode=ur2&camp=1789&creative=390957) or, better yet, contributing directly to [Meitar's Cyberbusking fund](http://Cyberbusking.org/). (Publishing royalties ain't exactly the lucrative income it used to be, y'know?) Your support is appreciated!
