Self diagnosis

[streetycat]

Fail to activate DIY OOD

Check the network environment of the target machine to install DIYOOD and the mobile phone to install CyberChat. Symmetric NAT will not be able to connect. you can improve the network connection environment or apply for an IPV6 address.

If you want to activate through the QR code after the installation of the DIYOOD installation package, se CyberChat to scan code;

If you activate it by using CyberChat to scan the intranet to find OOD and activate but cannot find it, please check the network environment of both parties to ensure that both parties are on the same LAN network segment, and the firewall is set correctly.

Fail to activate CYFS browser

The computer running the browser and `CyberChat` need to be on the same LAN segment, and the two can be directly connected. If they cannot be connected, please check the relevant firewall settings.

OOD/CYFS browser/CyberChat cannot connect each other

1. Check the network environment, the Symmetric NAT cannot connect, you need to improve the network connection environment, or apply for an `IPV6` address.

2. The time error between devices is too large, restart the device after aligning the clocks.
  *The `BDT` protocol package will change the encrypt key regularly, and this depands on the consistency of the system time between devices within a certain precision.

Browser shows error:'cyfs not defined'

1. Need to use`CYFS Browser`, or try to restart `CYFS Browser`.

Development envionment problems

`CYFS`currently has two version,`nightly`and`beta`. `nightly` is for inner useage；developers all use `beta`version.

If you encounter `nightly` related contents in the documentation, please change to `beta` version contents.

MetaMask version explanation

The Metamask plug-in is a regular version obtained from Chrome without any change. If you have concern about it, you can only use it to manage the test account or reinstall the plug-in by yourself.

connect to ${OOD-ID} failed

Connection between client and OOD failed, diagnosis:
1. Find the runtime log (where is the location see "log collection" section)
2. Find the corresponding time log `cyfs-runtime_bdt_${ProcessID}_r${seq}.log` 
3. Search for `ping` in the log. If you do not see logs with words `ping-resp, sn:`, it means that the `NAT traversal` service cannot be connected. Please contact `CYFS Dev Team` on Discord.
4. Otherwise, please check if `OOD` goes online successfully.

Why can't I connect to OOD after I use the mnemonic to recover CyberChat

Recover `CyberChat`will still use the OOD binded previouly. If your old OOD has been uninstalled/reinstalled, the recovered `CyberChat` will no longer work, you need to recreate a new DID (new mnemonic).

I execute a command but shows cannot find desc/sec

This command requires access to the identity (device/owner) description information, which contains two files (someone.desc and someone.sec) with the suffixes desc and sec. You need to specify their paths in detail ("${folder_path }${someone}"), "${someone}" is the description file name without suffix.

Log collection

If you encounter problems during development, you usually need to accurately describe the operation process in detail, and collect the relevant logs of the corresponding time point and submit them to the CYFS development team. The log paths of commonly used products are as follows:

1. Client brower Runtime

   windows:
   %appdata%\cyfs\log\cyfs-runtime

   MAC:
   ~/Library/Application Support/cyfs/log/cyfs-runtime

   Under the dir has cyfs-runtime_${ProcessID}_r${seq}.log,and corresponding connection layer log cyfs-runtime_bdt_${ProcessID}_r${seq}.log.

2. OOD cyfs-stack
   windows:

   cyfs-stack: c:\cyfs\log\gateway
   App store: c:\cyfs\log\app-manager
   Permission configuration: c:\cyfs\etc\meta\global-state${DecID}.json

   linux:
   cyfs-stack: /cyfs/log/gateway
   App store: /cyfs/log/app-manager
   Permission configuration: /cyfs/etc/meta/global-state/${DecID}.json

   MAC:
   Same as linux

   Under the same to paths as clinet side has ${ProcessName}_${ProcessID}_r${seq}.logand corresponding connection layer log ${ProcessName}_bdt_${ProcessID}_r${seq}.log.
   If you encounter permission problems, you can check the actual status in the above permission configuration file

3. App Client
   At present, it is mainly the web version. The client log of the app is usually on the console of the browser; in addition, the log of the browser Runtime is used for diagnosis.

4. App service side(OOD)

   windows:
   C:\cyfs\log\app${DecID}

   linux:
   /cyfs/log/app/${DecID}

   MAC:
   Same as linux

   Currently commonly used DecID:

   CyberChat: 9tGpLNna8UVtPYCfV1LbRN2Bqa5G9vRBKhDhZiWjd7wA
   CodeDAO: 9tGpLNnHNGVtwhQJ6qjXvVp17V8s6q5sSBBMKhMHnkZ5

5. CyberChat

   Android:
   /Android/data/com.cyfs.wallet.en/files

   IOS:
   There is currently no convenient way to collect

6. Emulator

   windows:
   C:\cyfs\log\app\zone-simulator

   linux:
   /cyfs/log/app/zone-simulator

   Related documents:
   https://github.com/buckyos/CYFS/blob/beta/doc/en/Decentralized_message_board_development/8.Use_the_emulator_to_test_the_app_across%20zones.md

7. VOOD

   VOOD is linux system. Fogworksprovidesssh login method. How to get ssh login parameters:

   • Log in to https://foggie.fogworks.io/ with your registered email address.
   • Find you own vood order in https://foggie.fogworks.io/#/pages/orderList/index.
   • Click Detail button
   • Click SSH Terminal，and you can see your ssh login parameters.

[streetycat]

Error: 262 post object must be handled by handler

check the processes is running:
1. gateway for OOD
2. cyfs-runtime for browser
3. DEC Service, is configed in your cyfs.config.json, as:

    {
        ... ignore
        "service": {
            ...
            "app_config": {
                "default": "service_package.cfg" // config for DecService
            },
        }
    }

    // service_package.cfg
    {
        "id": "dec-app-service-eood",
        "version": "1.0.0",
        "install": [...],   // install commands
        "start": ..., // start command
        "stop": ..., // stop command
        "status": ..., // polling for the status
        "executable": []
    }

[streetycat]

Where can I get the documents

You can find it in https://www.cyfs.com/document_en

[streetycat]

Connect failed with http://127.0.0.1:1318

the port(1318) is listening by the "gateway" process, you can check the process is running, and check the port(1318) is listening.
make sure your program is running on the OOD, if your OOD is not installed on your PC.

[streetycat]

How to get the user's address on the website

First, user must use CYFS browser to access the web page. Preferably a cyfs:// web page.
Then, in javascript, use cyfs.SharedCyfsStack to connect to local runtime, and use stack.local_device() method to get the device desc of runtime, and the owner of the device is the user's address

[streetycat]

Duplicate identifier when the *.ts is compiling

set compilerOptions.skipLibCheck = true in tsconfig.json

[streetycat]

about nightly

You should focus on the 'beta', 'nightly' is the test environment prepared by the "CYFS Dev Team" for its daily development work.

[streetycat]

How to push the Source code to the CodeDAO

1. Prepare the software

• Client: any command line tool for git
• Server: install the DecApp named CodeDAO withCYFS Browser, you can get the tutorial from the page with the final chapter.https://www.cyfs.com/document?node_id=932cab2c-8a87-497e-84c1-e5b461909eb3

2. Use the software as git

• Enter the CodeDAO from the Home Page of the CYFS Browser(cyfs://static/browser.html)
• Enter your Your User Profile
• Click the menu from your User avatar at the Upper right corner of the page
• Fill the profile of the repository, make it Public
• Initialize the repository with the git client, follow the guide on the page

        git init
        git add README.md
        git commit -m "first commit"
        git remote add origin cyfs://your-name/your-repository
        git push -u origin master

3. Attention

• If you meet the error: git: 'remote-cyfs' is not a git command. See 'git --help', You need to install the binary git-remote-cyfs in client first. the tutorial is also in the previous page. you will see the version infomation when you type the command git-remote-cyfs if you have installed it correctly.
• Some parameters are not fully supported in the current version，You need to merge the branch with the git client, so if you meet a error when you merge a remote branch from the CodeDAO using git pull, you can try as follow

git stash // make local clean
git pull // new version from remote
git stash pop // merge the local version to the remote