Clone the latest version of the repository using
git. (Use the Nattyv3 branch if you would like to run a older version of the file).
git clone https://github.com/SOBotics/Natty.git
BotRoomand configuring it as to what it needs to read, what it needs to display, where it needs to send, etc. (Here is the place where we set Natty to look only for NAAs on new posts and not all posts).
sh setup.sh. It will ask you for a set of data and then create the jar which you can run.
mvn clean package. A folder
/targetwill be created inside which a
.jarfile will be present. This is the complete bot code which you need to run.
At the same level of the
.jar file which you created. Create the following structure:
|--- data | |--- BlackListedUsers.txt | |--- BlackListedWords.txt | |--- CheckUsers.txt | |--- FeatureRequests.txt | |--- OptedInUsersList.txt | |--- Salutations.txt | --- WhiteListedWords.txt |--- logs | |--- fullReports.txt | |--- output.csv | |--- reports.txt | --- sentinelReports.txt |--- properties | --- login.properties
if you are tracking for AU as well, then you’ll need to create a
aulogs folder structure:
|--- aulogs | |--- fullReports.txt | |--- output.csv | |--- reports.txt | --- sentinelReports.txt
apikey=SE_API_KEY apitoken=SE_AUTH_TOKEN_ASSOCIATED userid=USER_ID_OF_THE_BOT username=USERNAME_OF_THE_BOT location=YOUR_COMPUTER_NAME email=EMAIL_ID password=PASSWORD sentinelKey=REGISTERED_KEY_FOR_SENTINEL sentinelApiKey=REGISTERED_KEY_TO_USE_SENTINEL_APIS fmsPath=PATH_TO_THE_END_DIRECTORY_OF_FMS fmsUrl=LINK_TO_THE_FMS_DOMAIN feedMsg=*Feed Kyll here*
if you are running a local instance, you will not need the sentinel keys and the autoflag keys.
At first, I had created a MVP and managed to get some sort of interface where <10k could see a post, even if it was deleted. The FMS was that. After that ArtOfCode wrote a nice Sentinel. However Sentinel might fail sometimes and we’d be losing a lot of data (once it was down for 2 months). So FMS still stands as a backup.
Now for the disclaimer, You can ignore this completely if you don’t want a dashboard. FMS is just a visual frontend for the report and serves no other purpose.
Setting up FMS is simple:
sh tomcat/bin/startup.sh. Tomcat would now be up and listening at Port 8080.
apache-tomcat-9.v.v/webapps/ROOT/Natty/(or use the fully qualified path) as the value for the parameter
http://localhost:8080/Nattyfor the parameter
fmsUrlin the login.properties file.
java -jar natty.jarand it will start to execute.