Skip to content

Latest commit

 

History

History
104 lines (69 loc) · 2.6 KB

install.md

File metadata and controls

104 lines (69 loc) · 2.6 KB

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 (recommanded)

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) :

# Download latest release in the current directory
curl -sSL https://raw.githubusercontent.com/sundowndev/phoneinfoga/master/support/scripts/install | bash

# Check the binary
./phoneinfoga version

# You can also install it globally
sudo mv ./phoneinfoga /usr/bin/phoneinfoga

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.

Using Docker

!!! info Be careful when using latest tag, it's updated directly from the master branch. We recommend using 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: phoneinfoga:latest
      command: serve
      ports:
        - "80:5000"

From the source code

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 output is sent to stdout so it can be inspected by running:

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