For AI agents: the complete documentation index is available at /en/llms.txt, the full documentation bundle is available at /en/llms-full.txt, and this page is available as Markdown at /en/guide/guides/reset-password.md.
  • English
  • Reset an Octop account password

    Pick the row that matches your situation, then open that section. A new password must be at least 8 characters, include a letter and a digit, and must not be a common value such as password123, admin123, or octop123.

    SituationWhat to do
    You can sign in and want to change your own passwordChange it in the web UI
    You are an admin changing someone else's passwordReset another user
    The password is forgotten and you can operate this machineReset on the host
    NOTE

    After you change the password, ~/octop-login.txt and Docker's credential.txt still contain the previous value. Use the password you just set.

    Change it in the web UI

    After you sign in:

    Open the avatar menu

    Click your avatar in the top-right corner.

    Change password

    Click Change password, then enter the current password and a new one.

    The same endpoint is available over curl. See Authentication: change password.

    Reset another user

    An admin who can still sign in can set a new password for someone else. Only the new password is required. See Users & admin API: reset a password.

    When the admin account is locked out as well, use the next section and reset it on the machine where Octop is installed.

    Reset on the host

    Run the command on the machine where Octop is installed, as the same OS account that runs the service. The command writes the local database directly. Octop can be stopped. A command-line install and the desktop client share one database: ~/.octop/octop.db (%USERPROFILE%\.octop\octop.db on Windows).

    octop user passwd changes the password only. If the account is locked out of an authenticator or passkey, clear those factors with octop user reset-mfa <username>. That does not change the password. The desktop shell can also renew an expired session from ~/.octop/desktop-device.json without showing the sign-in page.

    Replace <username> and <password> with real values. The username is a positional argument; --username fails with Error: No such option '--username'. Omit --password to type it interactively (the input is hidden). --password stays in shell history, so interactive entry is safer on a shared machine. If you are unsure of the username, list users in the same environment first.

    Pick your install type, then your system:

    Docker, FnOS, and Tencent Cloud follow those two sections.

    Command-line install

    The install script or pip puts octop on your PATH. The command is:

    octop user passwd <username> --password <password>
    macOS / Linux
    Windows

    The installer puts a wrapper in ~/.octop/bin and updates your shell profile. Open a new terminal, or run source ~/.zshrc / source ~/.bashrc.

    octop user list
    octop user passwd <username> --password <password>

    If the shell still cannot find octop, call it by full path in this order. If you started octop run or octop service as a different OS account, switch to that account first. Data lives under that account's ~/.octop/.

    SourcePath
    Installer wrapper~/.octop/bin/octop
    Isolated environment~/.octop/venv/bin/octop
    Custom OCTOP_HOME$OCTOP_HOME/bin/octop
    pip install octoppython3 -m octop

    For example:

    ~/.octop/bin/octop user passwd <username> --password <password>

    Then sign in at http://127.0.0.1:8088 (or the address you bound).

    Desktop client

    The client extracts a portable runtime to ~/.octop/portable (%USERPROFILE%\.octop\portable on Windows) and runs launch.py with its bundled Python. The runtime is extracted on first launch. If portable does not exist, start the client once.

    macOS / Linux
    Windows
    ~/.octop/portable/runtime/bin/python3 ~/.octop/portable/launch.py user list
    ~/.octop/portable/runtime/bin/python3 ~/.octop/portable/launch.py user passwd <username> --password <password>

    Then sign in at http://127.0.0.1:8088 (or the address you bound).

    Docker

    Run these on the host. Replace the container name octop with the name from docker ps. The image puts the CLI on PATH at /app/.venv/bin.

    docker exec -it octop octop user list
    docker exec -it octop octop user passwd <username> --password <password>

    If the container cannot find octop:

    docker exec -it octop /app/.venv/bin/octop user passwd <username> --password <password>

    The first-boot username defaults to admin. Override it with OCTOP_ADMIN_USERNAME. Compose bind-mounts the host ~/.octop to /data/.octop in the container, so the command updates that database.

    First-run password details are in Docker Setup: changing the admin password.

    FnOS

    Docker package (the web UI is usually http://<NAS-IP>:8088) — from the NAS terminal or SSH. Confirm the container name with docker ps:

    docker exec -it octop octop user list
    docker exec -it octop octop user passwd <username> --password <password>

    If the container cannot find octop:

    docker exec -it octop /app/.venv/bin/octop user passwd <username> --password <password>

    Native package (the web UI is usually http://<NAS-IP>:8089) — install links the CLI at /usr/local/bin/octop (it points at octop-cli). After you SSH in:

    octop user list
    octop user passwd <username> --password <password>

    If octop is not on your PATH, use /usr/local/bin/octop or /var/apps/octop-native/bin/octop-cli.

    WARNING

    /var/apps/octop-native/bin/octop starts the web service for App Center. Reset the password with the CLI above. That launcher would open a second service on port 8089.

    Confirm the username in the app Settings window. octop-login.txt in the data directory stores only the install-time bootstrap password. Run as octop-native or root so the data files keep their owner.

    Install steps are in FnOS.

    Tencent Cloud

    CVM — on the instance details page, click Log in and choose Password-free connection (TAT). The terminal switches from root to agentuser. Then run:

    octop user list
    octop user passwd <username> --password <password>

    If octop is missing, use that account's wrapper:

    ~/.octop/bin/octop user passwd <username> --password <password>

    The absolute path is usually /home/agentuser/.octop/bin/octop, then /home/agentuser/.octop/venv/bin/octop. The CVM setup wizard's one-time password is in ~/octop-login.txt. After setup, sign in with the account you created in the wizard.

    Lighthouse — SSH into the instance and run the same commands as the account that runs Octop. If octop is missing, run echo $HOME, then call $HOME/.octop/bin/octop. The URL comes from Application management → Octop console on the instance.

    Purchase and first login are in Use on Tencent Cloud.

    WARNING

    On a host that is reachable from the network, the generated or wizard password is only for first login. After a reset, sign in once with the new password.

    Full subcommands are in Channels & cron: octop user.