Skip to main content

Install & Update

Learn how to install and update Whinself using Docker.

Installation with Docker​

Whinself is available as a multi-architecture Docker image, supporting x86_64, ARM64, and ARM platforms. This ensures compatibility across a wide range of devices, from powerful servers to Raspberry Pi devices.

Step 1: Create the config.json File​

Create a new file named config.json in your local directory:

touch config.json

Add your desired configuration to the file. All configuration variables are optional; if you do not set any, the application will use default values for all settings. Here is an example with some variables set:

{
  "slotid": "my-whatsapp-bot",
  "nrurl": "https://host.example.com/api/newrelic",
  "portin": 9001
}

For a complete configuration with all options:

{
  "slotid": "my-whatsapp-bot",
  "nrurl": "https://whinself.free.beeceptor.com",
  "portin": 9001,
  "devicename": "WhatsApp Bot",
  "debuglevel": 0,
  "logsse": true,
  "logstdout": true
}

Both logsse and logstdout are optional settings. logsse will show logs on console while logsse will emit Server-Sent-Events (SSE) logging on /events/logs path

Note: Port 9001 is used as an example. You can use any non-reserved port (1024-65535) that is accessible on your server. Higher ports (e.g., 8000-9000 range) are generally recommended to avoid conflicts with other services.

Step 2: Run Docker Container with Configuration​

Pull and run the Whinself container with your config.json:

docker run \
    -v <absolute_path_to>/config.json:/app/config/config.json \
    -p 9001:9001 \
    --name whatsapp-bot \
    inutil/whingo:latest

Be mindful about:

  • You can replace 9001 with any available high port of your choice
  • Path to config.json must be absolute and no relative
  • The format is -p HOST_PORT:CONTAINER_PORT where both ports should match your portin value in config.json

Step 3: Verify Container Status​

Check if the container is running:

docker ps

Check container logs for configuration loading:

docker logs whatsapp-bot

If there are any configuration errors, they will be visible in the logs.

Step 4: Verify Web Interface Access​

To confirm that everything is working correctly:

  1. Open a web browser and navigate to:

    http://WHINSELF_IP:PORT

    (Replace PORT with the port you configured in your config.json file)

  2. You should see the Whinself welcome and registration screen

  3. If the page loads correctly, your installation has been successful and you can proceed with the registration and WhatsApp connection

  4. If you cannot access the web interface, check that:

    • The Docker container is running
    • Your firewall allows traffic on the configured port
    • You're using the correct IP address and port

Common Issues and Solutions​

File Permission Issues​

Ensure config.json has proper read permissions:

chmod 644 config.json

File Not Found​

  • Verify the path to config.json is correct
  • Use absolute paths when mounting volumes
  • Check if the file exists in the specified location
  • Ensure the file is mounted correctly in Docker

Invalid Configuration​

  • Check JSON syntax is valid
  • Verify all required fields are present
  • Ensure port number is valid (1025-65535)

Updating Whinself​

To update Whinself to the latest version:

  1. Pull the latest image:
docker pull inutil/whingo:latest
  1. Stop the current container:
docker stop whatsapp-bot
  1. Remove the old container:
docker rm whatsapp-bot
  1. Run the new container with your existing configuration:
docker run \
    -v <absolute_path_to>/config.json:/app/config/config.json \
    -p 9001:9001 \
    --name whatsapp-bot \
    inutil/whingo:latest

Important Disclaimer: Whinself is an unofficial third-party tool that connects to the WhatsApp network using your personal WhatsApp account. It is not affiliated with, authorized, maintained, sponsored, or endorsed by WhatsApp or Meta Platforms, Inc. By using this software, you are responsible for ensuring your usage complies with WhatsApp's Terms of Service.

Version Compatibility​

Whinself is compatible with the following versions:

  • Docker: 20.10 or higher