fishroom

(β˜… 292)

Message forwarding for multiple IM protocols

  • .gitignore
  • Dockerfile
  • LICENSE
  • README.md
  • requirements.txt

# Installation Guide

1. Get the code
git clone https://github.com/tuna/fishroom

Downloads the entire project code from GitHub to your computer.

cd fishroom

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • APT (Debian/Ubuntu 계열) Built into Debian/Ubuntu-based Linux distributions.
  • Python 3 Python is required to use pip.
apt-get install redis

Installs directly from the APT package repository (Debian/Ubuntu-based).

apt-get install -y python3-dev python3-pip libmagic1 libjpeg-dev libpng-dev libwebp-dev zlib1g-dev gcc

Installs directly from the APT package repository (Debian/Ubuntu-based).

pip3 install --upgrade pip setuptools

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker pull redis:alpine

Type this command into your terminal and run it.

docker run --name redis -v /var/lib/redis:/data -d redis:alpine

Runs the built image as an actual container.

docker build --tag fishroom:dev .

Builds a runnable image based on the Dockerfile.

docker run -it --rm --link redis:redis -v /path/to/fishroom/fishroom:/data/fishroom fishroom:dev python3 -u -m fishroom.fishroom

Runs the built image as an actual container.

docker run -it --rm --link redis:redis -v /path/to/fishroom/fishroom:/data/fishroom fishroom:dev python3 -u -m fishroom.telegram

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
apt-get install -y python3-dev python3-pip libmagic1 libjpeg-dev libpng-dev libwebp-dev zlib1g-dev gcc

Installs directly from the APT package repository (Debian/Ubuntu-based).

pip3 install --upgrade pip setuptools

Installs the package published on PyPI directly β€” no need to clone the source.

pip3 install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python3 -m fishroom.fishroom

Runs the Python script (or module).

python3 -m fishroom.telegram

Runs the Python script (or module).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation