Documentation Clarification Request

[hkunz]

I put up some documentation for myself since there was not much I could follow on a step by step basis in the README.md. Perhaps we can add this documentation in there for others to easily follow.

Repository: https://github.com/SOBotics/UserStalker
git clone https://github.com/SOBotics/UserStalker.git

Prerequisites

Install Java:

sudo apt update
sudo apt install default-jre
sudo apt install default-jdk

Export Java to Path:

export JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64  # Adjust this path based on your actual installation
export PATH=$PATH:$JAVA_HOME/bin

Install Maven:

sudo apt install maven

Install web socket (wscat):

sudo apt install node-ws
wscat -c wss://echo.websocket.org # Test web socket if it is allowed

Configuration

Add repositories node into root of pom.xml:

  <repositories>
      <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
      </repository>
  </repositories>

Add dependency child node into dependencies node of pom.xml:

  <dependency>
      <groupId>com.github.SOBotics</groupId>
      <artifactId>chatexchange</artifactId>
      <version>605ffcb</version>
  </dependency>
  <dependency>
      <groupId>org.glassfish.tyrus.bundles</groupId>
      <artifactId>tyrus-standalone-client-jdk</artifactId>
      <version>2.1.5</version>
  </dependency>
  <dependency>
      <groupId>javax.json</groupId>
      <artifactId>javax.json-api</artifactId>
      <version>1.0</version>
  </dependency>

Remove dependency child node (this one is replaced by com.github.SOBotics

  <dependency>
      <groupId>org.sobotics</groupId>
      <artifactId>chatexchange</artifactId>
      <version>2.0.0</version>
  </dependency>

Create a sock puppet account

• Create a sock puppet account to act as user stalker bot which automatically posts to chat
• Create chat account by visiting bot's chat link https://chat.stackexchange.com/users/{UserID}/
• Create a private chat room in your respective SE site (example for Blender: https://chat.stackexchange.com/?tab=site&host=blender.stackexchange.com
• Invite user stalker bot to chat by granting write access
• Try super ping user stalker bot with @@UserID

Update credentials of user stalker bot UserID in properties/login.properties:

  email=<user-stalker-bot-email>
  password=<user-stalker-bot-password> # (backslash/escape special characters)

Update properties/sites.properties (example blender and/or comma separate other SE sites):

  sitesFast=blender
  sitesSlow=meta
  nonEnglish=

Update properties/rooms.properties:

se=<RoomID>

Execution

Compile .jar file using maven:

mvn compile
mvn package

Move generated .jar file from target/ into repository root

mv target/UserStalker*.jar .

Launch UserStalker:

./LaunchUserStalker.sh

Optionally track the UserStalker.log file:

tail -n 100 -f UserStalker.log

[Bhargav-Rao]

Thanks, can you add this into a .md file and put it into a /docs folder? We can merge it in.

[Bhargav-Rao]

Actually, hold on. Some of those changes probably should be made to the base code itself. I'll see if I get some time sometime later this week and work on this. Thanks once again.