From 68d7ea0cb793205eee822cc56819c19f84d4b555 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hazel=20Vird=C3=B3?= Date: Mon, 10 Dec 2018 16:13:39 -0500 Subject: [PATCH] Copyedit for text on the website --- Server/IrssiNotifierServer/html/index.html | 108 ++++++++++----------- 1 file changed, 50 insertions(+), 58 deletions(-) diff --git a/Server/IrssiNotifierServer/html/index.html b/Server/IrssiNotifierServer/html/index.html index 2a92d5e..54be54a 100644 --- a/Server/IrssiNotifierServer/html/index.html +++ b/Server/IrssiNotifierServer/html/index.html @@ -1,6 +1,6 @@ - + @@ -156,39 +156,39 @@

IrssiNotifier+


-

What?

+

What is IrssiNotifier?

- Get notifications from IRC hilights and private messages straight to your Android™ device! Project is open source, see GitHub project page for details. Check Google Play™ for screenshots. There are also unofficial support for WeeChat and Python. + Get notifications from IRC hilights and private messages straight to your Android™ device! The project is open source and available on GitHub. Check Google Play™ for screenshots. There is also unofficial support for WeeChat and Python.

-

How?

+

How does it work?

- IrssiNotifier uses Irssi script to send IRC messages to server, and Google's Cloud to Device Messaging framework to send notifications to Android device. This minimizes the battery usage of your device, and enables notifications to be sent near real time. + IrssiNotifier uses an Irssi script to send IRC messages to the server, and Google's Cloud to Device Messaging framework to send notifications to your Android device. This minimizes the battery usage of your device and enables notifications to be sent in near real time.

Where?

- First download IrssiNotifier Android app from Google Play. After that, follow instructions about setting up the Irssi script in the help page. + First, download the IrssiNotifier Android app from Google Play. After that, follow the setup instructions on the help page.

What do I need?

- You'll need Irssi running on Linux server or similar (with wget installed). You'll also need an Android device (phone or tablet, or both) with Android version 2.2 (froyo) or later. + You'll need Irssi running on a Linux server or similar (with wget installed). You'll also need an Android device (phone, tablet, or both) with Android version 2.2 (froyo) or later.

-

Privacy?

+

What about privacy?

- All data is end-to-end encrypted with the encryption password of your choice. Password is never sent to the server. You'll have to login with your Google account, but no password or other sensitive data is collected. Check privacy page for details. + All data is end-to-end encrypted with the encryption password of your choice. The password is never sent to the server. You'll have to log in with your Google account, but no password or other sensitive data is collected. See the privacy page for details.

Who?

- This service was made by Lauri Härsilä, murgo @ IRCnet. If you have any questions, drop me a line by email or join #irssinotifier at IRCnet. Huge thanks to everybody who have donated money or contributed source! Thanks to Heidi Friman for icons. + This service was made by Lauri Härsilä, murgo @ IRCnet. If you have any questions, drop me a line by email or join #irssinotifier at IRCnet. Huge thanks to everyone who has donated money or contributed source! Thanks to Heidi Friman for icons.

How can I help?

- IrssiNotifier was created entirely on my free time. If you have found IrssiNotifier useful and want to help keep project alive, please consider buying the IrssiNotifier+ and/or donating through PayPal or Flattr. + IrssiNotifier was created entirely in my free time. If you have found IrssiNotifier useful and want to help keep project alive, please consider buying IrssiNotifier+ and/or donating through PayPal or Flattr.

@@ -210,28 +210,28 @@

IrssiNotifier+

What's new?

-

For latest developments, check project's Github page.

+

For the latest developments, see the project's Github page.

2.12.2018: IrssiNotifier 1.9.2 released.

- New version of the app has been released, that fixes only single message showing up in the app. Thanks to everybody for reporting, and special thanks to jheidel for debugging the issue. + A new version of the app has been released which fixes only single messages showing up in the app. Thanks to everybody for reporting, and special thanks to jheidel for debugging the issue.

11.11.2018: Android 9 is now supported.

- New version of the IrssiNotifier app (1.9.1) has been released, which removes Google Cloud Messaging in favor of Firebase Cloud Messaging to properly support Android Pie. + A new version of the IrssiNotifier app (1.9.1) has been released which removes Google Cloud Messaging in favor of Firebase Cloud Messaging to properly support Android Pie.

- Also new version (24) of Irssi script has been released with the following features: + A new version (24) of the Irssi script has been released with the following features:
    -
  • OpenSSL warnings are dismissed to get rid of AES-128 deprecation warnings of new OpenSSL. Probably not best practice. Feel free to fix properly and send PR.
    • -
  • New option: irssinotifier_required_channel_patterns can be used to whitelist channels (thanks smith153)
    • -
  • Improved Screen detection, some environments display screen socket differently thus breaking screen attach state detection (thanks benedicteb)
    • +
  • OpenSSL warnings are dismissed to get rid of AES-128 deprecation warnings of new OpenSSL. This is probably not a best practice, so feel free to fix it properly and open a PR.
    • +
  • A new option, irssinotifier_required_channel_patterns, can be used to whitelist channels (thanks smith153).
    • +
  • Improved screen detection. Some environments display screen socket differently thus breaking screen attach state detection (thanks benedicteb).

5.7.2017 Irssi script version 22 released.

- New version of OpenSSL is now supported. If you're having encryption troubles, try updating the script. + A new version of OpenSSL is now supported. If you're having encryption troubles, try updating the script.

21.2.2016 Server version 9 released.

@@ -241,28 +241,28 @@

What's new?

8.4.2014 Irssi script 20 released.

- The previously broken script is now (hopefully) fixed. If you installed script version 19 in the last couple of days, you might need to restart your Irssi or run following commands in Irssi after updating the script: + The previously broken script is now (hopefully) fixed. If you installed version 19 of the script in the last couple of days, you might need to restart your Irssi instance or run the following commands in Irssi after updating the script:
/script exec $SIG{CHLD} = 'IGNORE';
/script exec wait;
- Run the last line each for every zombie process you might have. Check earlier news post for more details. Please contact me if you are having issues. + Run the last line each for every zombie process you might have. Check the earlier news post for more details. Please contact me if you are having issues.

7.4.2014 Rollback of Irssi script 19.

- There's some issues with the latest release of the IrssiNotifier Irssi script, so it's been reverted until we get it fixed. Techinal jargon: broken script spawned a defunct zombie process for each highlight. If you have lots of Irssi zombie processes (ps x), run "/script exec wait;" in the Irssi. You have to run this one for each zombie process. + There's some issues with the latest release of the IrssiNotifier Irssi script, so it's been reverted until we get it fixed. Techinal jargon: the broken script spawns a defunct zombie process for each highlight. If you have lots of Irssi zombie processes (ps x), run "/script exec wait;" from Irssi. You have to run this once for each zombie process.

Sorry!

4.4.2014 Irssi script 19 released!

- Welp, it's been almost a year! Here's new script, thanks to people who fixed my stuff! Fixes and features: + Welp, it's been almost a year! Here's a new script. Thanks to people who fixed my stuff! Fixes and features:
    -
  • Support for tmux! tmux attach/detach state is used through the /set irssinotifier_screen_detached_only. Thanks to mlb- and vanaltj for this.
    • -
  • "Queue is full" error message should be fixed now, thanks qvr!
    • +
  • Support for tmux! tmux attach/detach state is used through /set irssinotifier_screen_detached_only. Thanks to mlb- and vanaltj for this.
    • +
  • "Queue is full" error message should be fixed now, thanks to qvr!
  • Couple of miscellaneous bug fixes.
@@ -445,15 +445,15 @@

Help!

{% if irssi_working %} -

Irssi script upgrade instructions

+

Upgrading the Irssi Script

- Don't worry, your settings won't get lost.
+ Your settings will persist when you upgrade the script.
    -
  1. Download Irssi script by copying and pasting the following command (as a single line) to your shell (don't mind any "File exists" -errors): +
  2. Download the Irssi script by copying and pasting the following command (as a single line) to your shell. You can ignore any "File exists" errors.
    mkdir -p ~/.irssi/scripts/autorun; wget --no-check-certificate https://irssinotifier.appspot.com/script/irssinotifier.pl -O ~/.irssi/scripts/irssinotifier.pl; ln -s ~/.irssi/scripts/irssinotifier.pl ~/.irssi/scripts/autorun/irssinotifier.pl
    3. -
  3. Reload Irssi script by typing the following command to Irssi: +
  4. Reload the Irssi script by entering the following command in Irssi:
    /script load irssinotifier
@@ -461,34 +461,27 @@

Irssi script upgrade instructions

{% endif %} -

Irssi script installation instructions

+

Initial Setup

- (To upgrade script, just follow steps 1 and 2). Script depends on wget and openssl. + This Irssi script depends on wget and openssl.
    -
  1. Download Irssi script by copying and pasting the following command (as a single line) to your shell (don't mind any "File exists" -errors): +
  2. Download the Irssi script by copying and pasting the following command (as a single line) to your shell. You can ignore any "File exists" errors.
    mkdir -p ~/.irssi/scripts/autorun; wget --no-check-certificate https://irssinotifier.appspot.com/script/irssinotifier.pl -O ~/.irssi/scripts/irssinotifier.pl; ln -s ~/.irssi/scripts/irssinotifier.pl ~/.irssi/scripts/autorun/irssinotifier.pl
    3. -
  3. Load Irssi script by typing the following command to Irssi: +
  4. Load the Irssi script by entering the following command in Irssi:
    /script load irssinotifier
    5. -
  5. Set api token in Irssi +
  6. Set your API token in Irssi.
    {% if logged_in %}/set irssinotifier_api_token {{ user.api_token }}{% else %}Log in to see instructions{% endif %}
    7. -
  7. Optional: Change your encryption password with the following command. You'll have to change the password to the Android device, too. Password can be anything you like (forbidden characters: ", \, `). Do not use your Google account password (or any other existing password) for security reasons. +
  8. Optional: Change your encryption password with the following command. You'll have to change the password on your Android device, too. The password can be anything you like (forbidden characters: ", \, `). Do not use your Google account password (or any other existing password) for security reasons.
    /set irssinotifier_encryption_password password
    9. -
  9. Ask someone to hilight you or send yourself a private message and check profile page to see if it works.
    10. -
-
- -

Android app installation instructions

- -
-
    -
  1. Download Android app from Google Play store.
    2. -
  2. Run the app, select the Google account you want to use. Account must be the same as the one you signed to this website with.
    3. -
  3. Go to settings and set your encryption password. Encryption password must be the same as the one you've set in Irssi script.
    4. +
  4. Download the Android app from the Google Play store.
    5. +
  5. Run the app and select the Google account you want to use. The account must be the same as the one you used to sign into this website.
    6. +
  6. Go to settings and set your encryption password. The encryption password must be the same as the one you've set in Irssi script.
    7. +
  7. Check your profile page to see if it's working. You can also ask someone to hilight you or send yourself a private message.
@@ -549,7 +542,7 @@

Additional Irssi commands

Troubleshooting

I'm not getting any notifications!

-

Follow the installation instructions to the letter. Check the profile page to see if the installation works (or at least it has been working). Ensure the script is loaded in your Irssi. If you have restored the Android app from backup, clear its data. Notifications might also be blocked by firewall if you use wi-fi. If you need more support, please visit #irssinotifier @ IRCnet or contact me by mail at murgo@iki.fi.

+

Follow the installation instructions to the letter. Check your profile page to see if the installation works (or at least has been working). Ensure the script is loaded in your Irssi. If you have restored the Android app from backup, clear its data. Notifications might also be blocked by firewall if you use wi-fi. If you need more support, please visit #irssinotifier @ IRCnet or contact me by mail at murgo@iki.fi.

Notifications work only every now and then!

Every device added to the system has certain limits for the amount of push notifications they can receive (about 20 per hour), which are reset gradually. Use above Irssi commands to reduce amount of wasteful messages sent to you. Furthermore, sometimes Android push notifications have unexpected delays, and some messages may even get lost.

@@ -589,7 +582,7 @@

Android client status

{% if token_count != 0 %} -

Android device(s) confirmed as working.

+

Your Android devices are confirmed as working.

Registered devices:

@@ -612,20 +605,20 @@

Registered devices:

{% else %} -

Android device not confirmed as working.

+

Your Android device is not confirmed as working.

{% endif %}

Irssi script status

{% if irssi_working %} -

Irssi script confirmed as working +

Your Irssi script is confirmed as working {% if irssi_latest %} - and is at latest version. + and is at the latest version. {% else %} - but is at old version. Check help page for upgrade instructions. + but is at an old version. See the help page for upgrade instructions. {% endif %}

{% else %} -

Irssi script not confirmed as working. Check help page for installation instructions.

+

Your Irssi script is not confirmed as working. See the help page for installation instructions.

{% endif %}

Operations

@@ -639,7 +632,7 @@

Operations

Privacy policy

-

User details are saved in Google App Engine data store. No user passwords (Google password, encryption password etc.) are saved at any time. Following personal information is saved from every user:

+

User details are saved in Google App Engine data store. No user passwords (Google password, encryption password, etc.) are saved at any time. The following personal information is saved from every user:

  • User name
    • @@ -650,11 +643,11 @@

    Privacy policy

  • Irssi script version
-

Messages are stored in the server for seven days. Messages are encrypted by user's own encryption password (be sure to change yours).

+

Messages are stored on the server for seven days. Messages are encrypted by the user's own encryption password (be sure to change yours).

-

User can wipe out his/her account from the profile page. This will remove all information regarding the user (including messages).

+

Users can wipe out their account from the profile page. This will remove all information regarding the user, including messages.

-

Anonymous statistics (analytics) will be gathered from users visiting this web site. Anonymous and statistical usage is also collected from Android app users (how many users, from which countries are they from etc.).

+

Anonymous statistics (analytics) will be gathered from users visiting this web site. Anonymous and statistical usage is also collected from Android app users (like how many users there are, which countries they're from, etc.).

@@ -674,4 +667,3 @@

Privacy policy

-