Skip to content
Snippets Groups Projects
commands.md 2.97 KiB
Newer Older
  • Learn to ignore specific revisions
  • # 💻 Commands
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    This section includes all common commands used on dev environment. These commands should be runned in `easy-cozy` directory.
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    cd easy-cozy
    ```
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    ## App
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    ### Install a specific version of an app
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    docker-compose exec cozy ./cozy apps update home --domain "[name].cozy.self-data.alpha.grandlyon.com" git://github.com/doubleface/cozy-collect.git#build-debug
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    ## Konnector
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    ### Install a specific version of a konnector
    
    
    ```bash
    # cozy-stack konnectors uninstall ${konn} --domain ${url}
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    docker-compose exec cozy ./cozy konnectors uninstall grdfgrandlyon --domain "[name].cozy.self-data.alpha.grandlyon.com"
    
    grdfgrandlyon has been uninstalled
    # cozy-stack konnectors install ${konn} --domain ${url}
    
    docker-compose exec cozy ./cozy konnectors install grdfgrandlyon --domain "[name].cozy.self-data.alpha.grandlyon.com" git://forge.grandlyon.com/web-et-numerique/factory/llle_project/grdf-adict-konnector.git#build
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    grdfgrandlyon (0.1.5) has been installed on [name].cozy.self-data.alpha.grandlyon.com
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    ### Update the version of a konnector
    
    
    ```bash
    $ cd /easy-cozy
    # cozy-stack konnectors update ${konn} --domain ${url}
    $ docker-compose exec cozy ./cozy konnectors update grdfgrandlyon --domain "[name].cozy.self-data.alpha.grandlyon.com"
    grdfgrandlyon has been upgraded to 0.1.5-d4bbe7350ecf13d13734f559c538e3c0ee8dc7ae
    ```
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    ### Run a konnector from the stack
    
    
    ```bash
    # cozy-stack konnectors run ${konn} --domain ${url}
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    docker-compose exec cozy ./cozy konnectors run grdfgrandlyon --domain "[name].cozy.self-data.alpha.grandlyon.com"
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    ## Instance
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    ### Set log level to debug for an instance
    
    
    ```bash
    # cozy-stack instances debug ${url} true
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    docker-compose exec cozy ./cozy instances debug --domain "[name].cozy.self-data.alpha.grandlyon.com" true
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    #### List all instances
    
    
    ```bash
    # cozy-stack instances ls
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    docker-compose exec cozy ./cozy instances ls
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    ## Stack
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    ### Check stack version
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    docker-compose exec cozy ./cozy version
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    ### Update stack version
    
    
    Update version in the Dockerfile on gitlab.
    
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    **On server :**
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    1. git pull or change locally the version in cozy-stack/Dockerfile
    
    2. create the docker image using:
    
    
       ```bash
       cd /easy-cozy/build
       ./build-docker-image.sh
       ```
    
    
    3. Start the container based on the built image
    
    
       ```bash
       cd ..
       docker-compose up -d cozy
       ```
    
    :::info Error encounter
    
    Docker container was not launched, when consulting logs we can see the following error
    
    > ./cozy: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.32' not found (required by ./cozy)
    
    We have replaced debian:stable-slim with ubuntu:20.10 as installer for our docker build: https://forge.grandlyon.com/pocs/cozy/easy-cozy/-/commit/48a30a03f209169e0f1ebb0d106bb4361e7cd167
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    
    ### Manipulate data
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    To read/write data from the stack you can run the following commands
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    ```sh
    docker-compose exec db curl -u [USER]:[PASSWORD] -X [METHOD] http://127.0.0.1:5984/[DATABASE]
    ```
    
    :warning: When updating a document, make sure to remove the `_id` and to add `_rev` fields