install.md

To install PhoneInfoga, you'll need to download the binary or build the software from its source code.

!!! info For now, only Linux, MacOS and Windows are supported. If you don't see your OS/arch on the release page on GitHub, it means it's not explicitly supported. You can build from source by yourself anyway. Want your OS to be supported ? Please open an issue on GitHub.

Binary installation (recommended)

Follow the instructions :

• Go to release page on GitHub

• Choose your OS and architecture

• Download the archive, extract the binary then run it in a terminal

You can also do it from the terminal (UNIX systems only) :

1. Download the latest release in the current directory

# Add --help at the end of the command for a list of install options
bash <( curl -sSL https://raw.githubusercontent.com/sundowndev/phoneinfoga/master/support/scripts/install )

2. Install it globally

sudo install ./phoneinfoga /usr/local/bin/phoneinfoga

3. Test to ensure the version you installed is up-to-date

./phoneinfoga version

To ensure your system is supported, please check the output of echo "$(uname -s)_$(uname -m)" in your terminal and see if it's available on the GitHub release page.

Homebrew

PhoneInfoga is now available on Homebrew. Homebrew is a free and open-source package management system for Mac OS X. Install the official phoneinfoga formula from the terminal.

brew install phoneinfoga

Docker

!!! info If you want to use the beta channel, you can use the next tag, it's updated directly from the master branch. But in most cases we recommend using latest, v2 or stable tags to only get release updates.

From docker hub

You can pull the repository directly from Docker hub

docker pull sundowndev/phoneinfoga:latest

Then run the tool

docker run --rm -it sundowndev/phoneinfoga version

Docker-compose

You can use a single docker-compose file to run the tool without downloading the source code.

version: '3.7'

services:
    phoneinfoga:
      container_name: phoneinfoga
      restart: on-failure
      image: sundowndev/phoneinfoga:latest
      command:
        - "serve"
      ports:
        - "80:5000"

Build from source

You can download the source code, then build the docker images

Build

Build the image

docker-compose build

CLI usage

docker-compose run --rm phoneinfoga --help

Run web services

docker-compose up -d

Disable web client

Edit docker-compose.yml and add the --no-client option

# docker-compose.yml
command:
  - "serve"
  - "--no-client"

Troubleshooting

All the output is sent to stdout, so it can be inspected by running:

docker logs -f <container-id|container-name>