Commit 226e06163065bfee07b061a7a622d4a245897739

Authored by Daniela Feitosa
1 parent ee67a978

README files for Spaminator and AntiSpam plugins

plugins/anti_spam/README 0 → 100644
@@ -0,0 +1,33 @@ @@ -0,0 +1,33 @@
  1 +README - AntiSpam (AntiSpam Plugin)
  2 +=======================================
  3 +
  4 +Plugin that checks comments against a spam checking service compatible
  5 +with the Akismet API.
  6 +
  7 +
  8 +Enable Plugin
  9 +-------------
  10 +
  11 +Also, you need to enable AntiSpam Plugin at your Noosfero:
  12 +
  13 +cd <your_noosfero_dir>
  14 +./script/noosfero-plugins enable anti_spam
  15 +
  16 +
  17 +Activate Plugin
  18 +-------------
  19 +
  20 +As a Noosfero administrator user, go to administrator panel:
  21 +
  22 +- Click on "Plugins" option
  23 +- Click on "AntiSpam Plugin" check-box
  24 +
  25 +Configure Plugin
  26 +----------------
  27 +
  28 +As a Noosfero administrator user, go to administrator panel:
  29 +
  30 +- Click on "Configuration" below the "AntiSpam Plugin"
  31 +- Fill in the "API key" field with the key generated after signing up to
  32 + akismet: https://akismet.com/signup/
  33 +- Save your changes
plugins/spaminator/README 0 → 100644
@@ -0,0 +1,44 @@ @@ -0,0 +1,44 @@
  1 +README - Spaminator (Spaminator Plugin)
  2 +=======================================
  3 +
  4 +Plugin that search and destroy spams and spammers.
  5 +
  6 +
  7 +Enable Plugin
  8 +-------------
  9 +
  10 +Also, you need to enable Spaminator Plugin at your Noosfero:
  11 +
  12 +cd <your_noosfero_dir>
  13 +./script/noosfero-plugins enable spaminator
  14 +
  15 +And run the migrations for Spaminator Plugin at your Noosfero:
  16 +cd <your_noosfero_dir>
  17 +
  18 +- Development environment:
  19 +rake db:migrate
  20 +
  21 +- Production environment:
  22 +RAILS_ENV=production rake db:migrate
  23 +
  24 +
  25 +Activate Plugin
  26 +-------------
  27 +
  28 +As a Noosfero administrator user, go to administrator panel:
  29 +
  30 +- Click on "Plugins" option
  31 +- Click on "Spaminator Plugin" check-box
  32 +
  33 +Configure Plugin
  34 +----------------
  35 +
  36 +As a Noosfero administrator user, go to administrator panel:
  37 +
  38 +- Click on "Configuration" below the "Spaminator Plugin"
  39 +- Define how often the plugin will run on "Period (days) for scanning spammers"
  40 +- Save your changes
  41 +
  42 +The "Scan now!" button will run spaminator plugin when clicked.
  43 +The "Deploy" button will schedule scanning to run after the period
  44 +defined on "Period (days) for scanning spammers".