3 Set up a self hosted instance
pluja edited this page 3 months ago

Setting up an iseeyour.cash instance is very easy. You will need to install docker and docker-compose.

Once installed, clone this repo with:

git clone https://codeberg.org/pluja/iseeyourcash

Then enter the directory with cd iseeyourcash.

Edit the configuration

Now we will edit the configuration for iseeyour.cash.

Open the docker-compose.yml file with your favorite editor, for example vim or nano. Change the MONGO_INIT_DB_ROOT_USERNAME and MONGO_INIT_DB_ROOT_PASSWORD.

By default these will be changeme and insecure respectivelly. Please, choose a good password to fit your needs. If it is a local instance, you don't need to change it.

Finally, there are two other environment variables you can change in the docker-compose file:

  • MAX_PAGES_TO_SCAN - Defines the number of pages from a twitter profile it will scan. By default it is 3. So if the user has a long history of tweets, it will scan the first 3 pages of their profile.
  • RESCAN_MINUTES - Defines the amount of time that needs to be waited before being able to scan again a user profile. By default it is set to 60 minutes, so it means that a particular user can be re-scaned every 60 minutes.

Start the app

The app will start by default on port 1338 and the database will start on default mongoDB port 27017. If you have other MongoDB instances and want to run this app, and you don't know how to do it, please open an issue and I will assist you on how to do it.

To start the app just run:

docker-compose up -d

This will build the iseeyourcash image and download the mongodb image. Be patient, it may take some minutes.

If the command does not work, you may need to use sudo for it.

Updating

To update go to the project folder on your machine and run git pull to pull the new changes. Then run sudo docker-compose up -d --build to rebuild.