github.com/NVIDIA/aistore@v1.3.23-0.20240517131212-7df6609be51d/api/env/README.md (about)

     1  ## System environment variables
     2  
     3  The package contains system environment variables - globally defined names that include `AIS_ENDPOINT`, `AIS_AUTHN_TOKEN_FILE`, and more.
     4  
     5  As such, the `env` package is, effectively, part of the API: the names defined here are used throughout, both in the Go code and in the scripts. In particular, deployment scripts.
     6  
     7  > It is important to preserve consistency and reference the same names (without copy-paste duplication, when possible)
     8  
     9  * `ais.go`:   AIS environment
    10  * `authn.go`: AuthN environment
    11  
    12  ## See also
    13  
    14  * List of _all_ [environment variables](https://github.com/NVIDIA/aistore/blob/main/docs/environment-vars.md)
    15  * List of [system filenames ("filename constants")](https://github.com/NVIDIA/aistore/blob/main/cmn/fname/fname.go)