Configuration File Options

Option	Description	Example
name	Project name to display in Framna Docs. If none is provided the repository name (stripped from with the postfix) is used.	name: My Project
image	Name of an image file stored in the root of the repository to be used as the project's icon. A 256x256 PNG works well.	icon: icon.png
defaultSpecificationName	The specification to be displayed per default if none is selected. Useful when the project has multiple specs.	defaultSpecificationName: partner-api-openapi.yml
remoteVersions	Reference specifications from remote sources. Specifications can be behind IP-whitelisting or basic auth. See https://github.com/shapehq/framna-docs/wiki/Adding-Documentation-to-Framna-Docs#displaying-remote-versions-and-specifications for more info.	See below.

Remote versions

See https://github.com/shapehq/framna-docs/wiki/Adding-Documentation-to-Framna-Docs#displaying-remote-versions-and-specifications for how to use.

remoteVersions:
  - name: Production
    specifications:
    - name: Foo Service
      url: https://foo.example.com/api/swagger/v1/swagger.yaml
    - name: Bar Service
      url: https://bar.example.com/api/swagger/v1/swagger.yaml
    - name: FooBar Service
      url: https://foobar.example.com/api/swagger/v1/swagger.yaml
      auth:
        type: basic
        encryptedUsername: iOYpcgoScpY+CsueQB5bk/J34GmNZbUBzeh4Em46TbUCzdX0Iwp3XbODS6WuR+sh7j5p5wI...
        encryptedPassword: lChXZ+Qf6OoakRBKAho1cYhrQQ7vlx46K/8I3eL1VZDweun4vTXdpjL5x1bGDD170tyZagT...
  - name: Development
    specifications:
    - name: Foo Service
      url: https://foo-dev.example.com/api/swagger/v1/swagger.yaml
    - name: Bar Service
      url: https://bar-dev.example.com/api/swagger/v1/swagger.yaml