Well-known files

Well-known files enable you to add functionalities such as Apple app site association, Apple Pay, and Android link verification. They also support other use cases, including publishing a security.txt file, which provides contact information for reporting security vulnerabilities on websites.

Features

This feature is available exclusively on Pro and Enterprise plans. You can host up to 30 well-known files per project. These files will always be stored under a special path called /.well-known/.

Both TXT and JSON files can be uploaded and hosted as well-known files. Note that subfolders within the /.well-known/ path are not supported.

File naming conventions

When uploading well-known files, it is essential to follow the specific naming conventions required by the third-party service. For instance, if you are integrating with Apple for app site association, the file must be named exactly apple-app-site-association and should be accessible at example.com/.well-known/apple-app-site-association (without any file extension in this case).

Similarly, for Android asset links, the JSON file must be named assetlinks.json and should be hosted at example.com/.well-known/assetlinks.json. Naming it assetlinks without the .json extension would be incorrect.

Please note that if you upload a file with special characters or trailing spaces, such as security .txt(note the whitespace before .txt), these characters will be removed, resulting in a simplified file name, in this case, security.txt.

How to upload well-known files

To upload well-known files, first access your project and go to the project settings. In the settings, find the section for well-known files and upload your TXT or JSON files there. After uploading, publish your site, and your uploaded well-known file(s) will be accessible via the corresponding /.well-known/ path.

By following these guidelines, you can easily integrate with various third-party services using well-known files hosted on your Framer site.