Update readme

This commit is contained in:
Daniel Winzen
2020-10-16 17:26:11 +02:00
parent 310e1cea86
commit addb6b24d8
2 changed files with 10 additions and 39 deletions

31
README
View File

@ -1,31 +0,0 @@
GENERAL INFORMATION:
This is a set of script to list TOR hidden services. An up-to-date copy can be downloaded at https://github.com/DanWin/onion-link-list
INSTALLATION INSTRUCTIONS:
You'll need to have php with pdo_mysql, pcre, json and date extension, a web-server and a MySQL server installed.
When you have everything installed, you'll have to create a database and a user for the script.
Then edit the configuration in common_config.php to reflect the appropriate database settings and to modify the settings the way you like them.
Then copy the scripts to your web-server directory and open the setup.php script like this: http://(server)/setup.php
Note: If you updated the script, please visit http://(server)/setup.php again, to make sure, that any database changes are applied and no errors occure.
At last set up cron jobs for update.php phishing_tests.php and background_tests.php
Recommended schedule:
update.php - every 24 hours
phishing_tests.php - every 24 hours, shortly after update.php
background_tests.php - every 15 minutes
TRANSLATING:
Copy lang_en.php and rename it to lang_YOUR_LANGCODE.php
Then edit the file and translate the messages into your language and change $I to $T at the top.
If you ever use a ' character, you have to escape it by using \' instead or the script will fail.
When you are done, you have to edit common_config.php, to include your translation. Simply add a line with
'lang_code' => 'Language name',
to the $L array below the settings, similar to what I did for the German translation.
Please share your translation with me, so I can add it to the official version.
To update your translation, you can copy each new string to your translation file or edit the automated lang_update.php script to reflect you language and run it.
LIVE DEMO:
If you want to see the scripts in action, you can visit my TOR hidden service http://tt3j2x4k5ycaa5zt.onion/onions.php or via a tor2web proxy like http://tt3j2x4k5ycaa5zt.onion.to/onions.php if you don't have TOR installed.

View File

@ -1,7 +1,7 @@
General information: General information:
-------------------- --------------------
This is a set of script to list TOR hidden services. An up-to-date copy can be downloaded at https://github.com/DanWin/onion-link-list This is a set of script to list Tor hidden services. An up-to-date copy can be downloaded at https://github.com/DanWin/onion-link-list
Installation instructions: Installation instructions:
-------------------------- --------------------------
@ -9,9 +9,9 @@ Installation instructions:
You'll need to have php with pdo_mysql, pcre, json and date extension, a web-server and a MySQL server installed. You'll need to have php with pdo_mysql, pcre, json and date extension, a web-server and a MySQL server installed.
When you have everything installed, you'll have to create a database and a user for the script. When you have everything installed, you'll have to create a database and a user for the script.
Then edit the configuration in common_config.php to reflect the appropriate database settings and to modify the settings the way you like them. Then edit the configuration in common_config.php to reflect the appropriate database settings and to modify the settings the way you like them.
Then copy the scripts to your web-server directory and open the setup.php script like this: ```http://(server)/setup.php``` Then copy the scripts to your web-server directory and run the `setup.php` script from cli, if possible.
Note: If you updated the script, please visit ```http://(server)/setup.php``` again, to make sure, that any database changes are applied and no errors occure. Note: If you updated the script, please run `setup.php` again, to make sure, that any database changes are applied and no errors occur.
At last, set up cron jobs for update.php phishing_tests.php and background_tests.php At last, set up cron jobs for the scripts in the `cron` directory.
Recommended schedule: Recommended schedule:
@ -19,16 +19,18 @@ update.php - every 24 hours
phishing_tests.php - every 24 hours, shortly after update.php phishing_tests.php - every 24 hours, shortly after update.php
background_tests.php - every 15 minutes scam_tests.php - every 24 hours
tests.php - every 15 minutes
Translating: Translating:
------------ ------------
Copy lang_en.php and rename it to lang_YOUR_LANGCODE.php Copy lang_en.php and rename it to lang_YOUR_LANGCODE.php
Then edit the file and translate the messages into your language and change $I to $T at the top. Then edit the file and translate the messages into your language and change $I to $T at the top.
If you ever use a ' character, you have to escape it by using \' instead or the script will fail. If you ever use a ' character, you have to escape it by using \' instead, or the script will fail.
When you are done, you have to edit common_config.php, to include your translation. Simply add a line with When you are done, you have to edit common_config.php, to include your translation. Simply add a line with
```'lang_code' => 'Language name',``` `'lang_code' => 'Language name',`
to the $L array below the settings, similar to what I did for the German translation. to the $L array below the settings, similar to what I did for the German translation.
Please share your translation with me, so I can add it to the official version. Please share your translation with me, so I can add it to the official version.
To update your translation, you can copy each new string to your translation file or edit the automated lang_update.php script to reflect you language and run it. To update your translation, you can copy each new string to your translation file or edit the automated lang_update.php script to reflect you language and run it.
@ -36,4 +38,4 @@ To update your translation, you can copy each new string to your translation fil
Live Demo: Live Demo:
---------- ----------
If you want to see the scripts in action, you can visit my TOR hidden service http://tt3j2x4k5ycaa5zt.onion/onions.php or via a tor2web proxy like http://tt3j2x4k5ycaa5zt.onion.to/onions.php if you don't have TOR installed. If you want to see the scripts in action, you can visit my Tor hidden service http://donionsixbjtiohce24abfgsffo2l4tk26qx464zylumgejukfq2vead.onion/onions.php or via my clearnet proxy https://onions.danwin1210.me/onions.php if you don't have Tor installed.