# orchardgo static

This directory contains static files relevant to `orchardgo` to be hosted on the specified root domains. The 
[`orchardgo-static-pipeline` Jenkins job](https://pipeline.theorchard.io/job/orchardgo-static-pipeline/) 
will deploy these files to the corresponding domains whenever changes are made to these files.

**Please exercise caution when changing these, and be absolutely sure that your changes will not break any existing
application functionality.**

The structure roughly mirrors:

```
static
├── cdn.theorchard.io
│   └── mobile-config.json
└── insights.theorchard.com
    └── .well-known
        ├── apple-app-site-association
        └── assetlinks.json
```

## Specific Files

### `cdn.theorchard.io/mobile-config.json`

Located at the CDN route, `mobile-config.json` contains parameters that need to be quickly accessed by OrchardGo
**before** a user logs into the application:

```
static
└── cdn.theorchard.io
    └── mobile-config.json
```

At present, the use case for this is to provide `"supported"` and `"required"` semantic versions which determine
whether we will suggest or require users to update their application binary.

### `insights.theorchard.com/.well-known/apple-app-site-association`

This file is used by iOS to route links into `orchardgo`. Please refer to the [Apple documentation on this file](https://developer.apple.com/library/archive/documentation/General/Conceptual/AppSearch/UniversalLinks.html)
when making any changes.

```
static
└── insights.theorchard.com
    └── .well-known
        └── apple-app-site-association
```

### `insights.theorchard.com/.well-known/assetlinks.json`

This file is used by Android to route links into `orchardgo`. Please refer to the [Android documentation](https://developer.android.com/training/app-links/verify-site-associations)
when making any changes.

```
static
└── insights.theorchard.com
    └── .well-known
        └── assetlinks.json
```