github.com/joey-fossa/fossa-cli@v0.7.34-0.20190708193710-569f1e8679f0/docs/integrations/archive.md (about)

     1  # Archive
     2  
     3  ## Support
     4  
     5  Repositories that vendorize archives of known open source packages in other supported integration formats are supported using the FOSSA archive uploader. This can be used to upload unsupported languages and run a full license scan on the included files.
     6  
     7  > Note: The archive uploader by default uploads all source code of the specified file or directory to the endpoint specified in the configuration.
     8  
     9  ## Usage
    10  
    11  > Note: Automatic configuration does not exist for archive modules.
    12  
    13  Add a module with `type` set to `raw` and `target` set to the directory or file to be uploaded.
    14  
    15  ```yaml
    16  analyze:
    17    modules:
    18      - name: your-custom-project
    19        type: raw
    20        path: .
    21        target: ./<directory-or-file>
    22  ```
    23  
    24  ### Analysis
    25  
    26  Archive analysis is done entirely by the FOSSA backend and the FOSSA-CLI's only job is to upload source code so that it can be analyzed. The following steps are taken to ensure this is done properly:
    27  1. A tarball is created from all files located in the `target`.
    28  2. FOSSA-CLI asks FOSSA for a secure S3 endpoint to upload the created tarball.
    29  3. The tarball is uploaded and FOSSA begins analyzing each file individually.