ClearFox logoClearFox
← All docs

Commands

Slash commands and prompts for the ClearFox chat.

Useful Commands

View Portal Logs

  1. 1

    View real-time logs from the portal container:

    docker compose logs -f portal --tail 100
  2. 2

    Each service keeps its last 30 MB of logs (3 rotated 10 MB files) — older lines are dropped. Logs survive a restart, but an update recreates the containers and starts them fresh, so export anything you need before running an update.

Restart Services

  1. 1

    Restart all ClearFox services:

    docker compose restart

Stop ClearFox

  1. 1

    Stop all containers (data is preserved):

    docker compose down

Reset User Password

  1. 1

    Passwords are stored as bcrypt hashes and cannot be recovered. You can only set a new one.

  2. 2

    Generate a new bcrypt hash (replace NEW_PASSWORD with your new password):

    docker compose exec portal sh -c "cd /tmp && npm install --no-save bcryptjs 2>/dev/null && node -e \"require('/tmp/node_modules/bcryptjs').hash('NEW_PASSWORD',12,function(e,h){console.log(h)})\""
  3. 3

    Copy the output hash (starts with $2a$12$...) and update the user in the database (replace admin@example.com and HASH):

    docker compose exec mongodb mongosh portal --eval 'db.users.updateOne({email:"admin@example.com"},{$set:{passwordHash:"HASH",updatedAt:new Date()}})'
  4. 4

    If the output shows modifiedCount: 1, the password has been changed. You can now log in.

Reset Database

  1. 1

    Drop the portal database. This removes all data — users, settings, conversations:

    docker compose exec mongodb mongosh portal --eval "db.dropDatabase()"
  2. 2

    After reset, restart the portal and go through the setup wizard again:

    docker compose restart portal