Share settings via URL

LobeHub support import settings from external URL to quickly set up LobeHub configuration.

The currently supported settings are:

• keyVaults: provider api key and baseURL settings
• languageModel: Language model settings

Import from URL

Use the following URL format to import settings parameters from an external URL:

https://lobehub.com/?settings=<settings object in JSON format>
https://lobehub.com/?settings={"keyVaults":{"openai":{"apiKey":"user-key","baseURL":"https://your-proxy.com/v1"}}}

Example of settings in JSON format:

{
  "keyVaults": {
    "openai": {
      "apiKey": "user-key"
    }
  }
}

Export settings to URL

// Generate settings to export to URL
const settings = {
  keyVaults: {
    openai: {
      apiKey: 'user-key',
      baseURL: 'https://your-proxy.com/v1',
    },
  },
};
// Convert settings to a JSON formatted string
const url = `/?settings=${JSON.stringify(settings)}`;
console.log(url);
// /?settings={"keyVaults":{"openai":{"apiKey":"user-key","baseURL":"https://your-proxy.com/v1"}}}

<Callout type={'warning'}> LobeHub does not verify the correctness of the settings parameters in the URL, nor provide encryption or decryption methods. Please use with caution. </Callout>

Parameter schema

keyVaults

• Property name and type

• Type OpenAICompatibleKeyVault

• Type AzureOpenAIKeyVault

• Type AWSBedrockKeyVault

languageModel

export type UserModelProviderConfig = Record<string, ProviderConfig>;

• Type ProviderConfig