How-To Run NumberWalk Locally

Docker allows you to run NumberWalk locally on your own computer without needing to access the website. This guide will walk you through installing Docker and setting up NumberWalk on your personal machine.

Part 1: Installing Docker on Your Computer

For Windows Users:

• Check your Windows version

  Make sure you have Windows 10 or newer.

• Download Docker Desktop
  • Visit Docker's official download page
  • Click the "Download for Windows" button
  • Wait for the installer file to download
• Install Docker Desktop
  • Double-click the downloaded file and follow the simple installation instructions
  • Restart your computer when prompted
  • After restarting, Docker will start automatically (look for the whale icon in your taskbar)

For Mac Users:

• Check your Mac

  Make sure you have macOS version 10.15 (Catalina) or newer.

• Download Docker Desktop
  • Visit Docker's official download page
  • Click the "Download for Mac" button
  • Wait for the installer file to download
• Install Docker Desktop
  • Open the downloaded .dmg file
  • Drag the Docker icon to your Applications folder
  • Open Docker from your Applications folder

For Linux Users:

Visit the Docker's official installation guide for Linux and select your distribution for specific instructions.

Part 2: Running NumberWalk Using Script

The deployment script handles all technical details automatically. Here's how to use it:

Step 1: Download the Deployment Script

• For Windows users: Download the deploy_script.bat file
• For Mac/Linux users: Download the deploy_script.sh file
• Save it somewhere easy to find, like your Downloads folder or Desktop

Step 2: Optional Settings

You can customize how NumberWalk runs on your computer by setting these optional environment variables:

For Windows users:

set DOCKER_PORT=5000       # App will run on localhost:5000
set DEPLOY_NAME=numberwalk # Container name
set LOG_DIR=C:\logs       # Where to store logs

For Mac and Linux users:

export DOCKER_PORT=5000      # App will run on localhost:5000
export DEPLOY_NAME=numberwalk # Container name
export LOG_DIR=/var/log      # Where to store logs

Note: These settings are completely optional. If you don't set them, the script will use default values.

Step 3: Run the Script

For Windows users:

In the same Command Prompt window, navigate to where you saved the script and run it:

cd C:\path\to\folder
deploy_script.bat

For Mac and Linux users:

In the same Terminal window, navigate to where you saved the script and run it:

cd /path/to/folder
chmod +x deploy_script.sh
./deploy_script.sh

Step 4: Access NumberWalk

• Once the script completes successfully, open your web browser
• Go to: http://localhost:5000 (or the port you specified)
• You should now see NumberWalk running locally on your computer!

Checking Logs (If Something Goes Wrong)

If you encounter issues, you can check the log files to see what happened:

• For Windows: Look in C:\logs\numberwalk\ (or the folder you specified with LOG_DIR environment variable)
• For Mac/Linux: Look in /var/log/numberwalk/ (or the folder you specified with LOG_DIR environment variable)
• You can view the logs with any text editor or using these commands:

For Windows users:

type C:\logs\numberwalk\app.log           # View application logs
type C:\logs\numberwalk\error.log         # View error logs
findstr "ERROR" "C:\logs\numberwalk\*.log" # Search for errors in all logs

For Mac and Linux users:

tail -f /var/log/numberwalk/app.log    # View live application logs
less /var/log/numberwalk/error.log     # Browse error logs

Stopping and Starting NumberWalk

To stop NumberWalk:

For all users:

docker stop numberwalk

To restart it later:

docker start numberwalk

Troubleshooting Common Issues

If Docker won't start:

• Restart your computer and try again
• Make sure your computer meets the minimum requirements for Docker
• On Windows, you might need to enable virtualization in your BIOS settings

If you can't access NumberWalk at localhost:5000:

• Make sure Docker is running (look for the whale icon in your taskbar)
• Check if the script finished successfully without error messages
• Try using a different port by setting DOCKER_PORT to another number (like 8080)
• Check if another program is already using port 5000 on your computer
• For Windows users: Make sure you're running Command Prompt as an administrator if you encounter permission issues
• For Windows users: Check Windows Defender Firewall settings if you can't access the port

Need More Help?

If you continue to experience issues, please:

• Take a screenshot of any error messages
• Contact support at [email protected]
• Include the log files if possible

Benefits of Running NumberWalk Locally

• Privacy: Your financial data stays on your computer
• Offline Access: Use NumberWalk even without internet connection
• Performance: Faster response times than the web version
• Availability: Use NumberWalk even when the website is undergoing maintenance