2023-04-13 16:13:32 +00:00
|
|
|
################################################################################
|
|
|
|
|
### AUTO-GPT - GENERAL SETTINGS
|
|
|
|
|
################################################################################
|
|
|
|
|
# EXECUTE_LOCAL_COMMANDS - Allow local command execution (Example: False)
|
|
|
|
|
EXECUTE_LOCAL_COMMANDS=False
|
|
|
|
|
|
Improve .env File Organization, Readability, and Documentation
This pull request aims to enhance the organization, readability, and understanding of the .env.template file for users when they modify the settings. The changes include organizing the file in a tree-like structure with appropriate comments, providing clear guidance for users about the purpose of each variable, their possible values, and default settings when applicable.
As a user with no prior knowledge of best practices of contributing to a project / .env.template file documentation, I took the liberty to make changes to the file based on what I would have liked to have seen when I first encountered it. My goal was to include every configurable option for ease of use and better understanding of how the code works.
The key improvements made in this pull request are:
1. Grouping related variables under appropriate headers for better organization and ease of navigation.
2. Adding informative comments for each variable to help users understand their purpose and possible values.
3. Including default values in the comments to inform users of the consequences of not providing a specific value for a variable, allowing them to make
informed decisions when configuring the application.
4. Formatting the file consistently for better readability.
These changes will enhance user experience by simplifying the configuration process and reducing potential confusion. Users can quickly and easily configure the application without having to search through the code to determine default values or understand the relationship between various settings. Additionally, well-organized code and documentation can lead to fewer issues and misunderstandings, saving time for both users and maintainers of the project.
Please review these changes and let me know if you have any questions or suggestions for further improvement so I can make any necessary adjustments.
2023-04-12 16:54:10 +00:00
|
|
|
################################################################################
|
|
|
|
|
### LLM PROVIDER
|
|
|
|
|
################################################################################
|
|
|
|
|
|
|
|
|
|
### OPENAI
|
|
|
|
|
# OPENAI_API_KEY - OpenAI API Key (Example: my-openai-api-key)
|
2023-04-13 16:13:32 +00:00
|
|
|
# TEMPERATURE - Sets temperature in OpenAI (Default: 1)
|
Improve .env File Organization, Readability, and Documentation
This pull request aims to enhance the organization, readability, and understanding of the .env.template file for users when they modify the settings. The changes include organizing the file in a tree-like structure with appropriate comments, providing clear guidance for users about the purpose of each variable, their possible values, and default settings when applicable.
As a user with no prior knowledge of best practices of contributing to a project / .env.template file documentation, I took the liberty to make changes to the file based on what I would have liked to have seen when I first encountered it. My goal was to include every configurable option for ease of use and better understanding of how the code works.
The key improvements made in this pull request are:
1. Grouping related variables under appropriate headers for better organization and ease of navigation.
2. Adding informative comments for each variable to help users understand their purpose and possible values.
3. Including default values in the comments to inform users of the consequences of not providing a specific value for a variable, allowing them to make
informed decisions when configuring the application.
4. Formatting the file consistently for better readability.
These changes will enhance user experience by simplifying the configuration process and reducing potential confusion. Users can quickly and easily configure the application without having to search through the code to determine default values or understand the relationship between various settings. Additionally, well-organized code and documentation can lead to fewer issues and misunderstandings, saving time for both users and maintainers of the project.
Please review these changes and let me know if you have any questions or suggestions for further improvement so I can make any necessary adjustments.
2023-04-12 16:54:10 +00:00
|
|
|
# USE_AZURE - Use Azure OpenAI or not (Default: False)
|
2023-04-03 21:29:55 +00:00
|
|
|
OPENAI_API_KEY=your-openai-api-key
|
2023-04-12 23:28:21 +00:00
|
|
|
TEMPERATURE=1
|
2023-04-05 17:44:28 +00:00
|
|
|
USE_AZURE=False
|
Improve .env File Organization, Readability, and Documentation
This pull request aims to enhance the organization, readability, and understanding of the .env.template file for users when they modify the settings. The changes include organizing the file in a tree-like structure with appropriate comments, providing clear guidance for users about the purpose of each variable, their possible values, and default settings when applicable.
As a user with no prior knowledge of best practices of contributing to a project / .env.template file documentation, I took the liberty to make changes to the file based on what I would have liked to have seen when I first encountered it. My goal was to include every configurable option for ease of use and better understanding of how the code works.
The key improvements made in this pull request are:
1. Grouping related variables under appropriate headers for better organization and ease of navigation.
2. Adding informative comments for each variable to help users understand their purpose and possible values.
3. Including default values in the comments to inform users of the consequences of not providing a specific value for a variable, allowing them to make
informed decisions when configuring the application.
4. Formatting the file consistently for better readability.
These changes will enhance user experience by simplifying the configuration process and reducing potential confusion. Users can quickly and easily configure the application without having to search through the code to determine default values or understand the relationship between various settings. Additionally, well-organized code and documentation can lead to fewer issues and misunderstandings, saving time for both users and maintainers of the project.
Please review these changes and let me know if you have any questions or suggestions for further improvement so I can make any necessary adjustments.
2023-04-12 16:54:10 +00:00
|
|
|
|
2023-04-13 16:13:32 +00:00
|
|
|
### AZURE
|
Improve .env File Organization, Readability, and Documentation
This pull request aims to enhance the organization, readability, and understanding of the .env.template file for users when they modify the settings. The changes include organizing the file in a tree-like structure with appropriate comments, providing clear guidance for users about the purpose of each variable, their possible values, and default settings when applicable.
As a user with no prior knowledge of best practices of contributing to a project / .env.template file documentation, I took the liberty to make changes to the file based on what I would have liked to have seen when I first encountered it. My goal was to include every configurable option for ease of use and better understanding of how the code works.
The key improvements made in this pull request are:
1. Grouping related variables under appropriate headers for better organization and ease of navigation.
2. Adding informative comments for each variable to help users understand their purpose and possible values.
3. Including default values in the comments to inform users of the consequences of not providing a specific value for a variable, allowing them to make
informed decisions when configuring the application.
4. Formatting the file consistently for better readability.
These changes will enhance user experience by simplifying the configuration process and reducing potential confusion. Users can quickly and easily configure the application without having to search through the code to determine default values or understand the relationship between various settings. Additionally, well-organized code and documentation can lead to fewer issues and misunderstandings, saving time for both users and maintainers of the project.
Please review these changes and let me know if you have any questions or suggestions for further improvement so I can make any necessary adjustments.
2023-04-12 16:54:10 +00:00
|
|
|
# OPENAI_AZURE_API_BASE - OpenAI API base URL for Azure (Example: https://my-azure-openai-url.com)
|
|
|
|
|
# OPENAI_AZURE_API_VERSION - OpenAI API version for Azure (Example: v1)
|
|
|
|
|
# OPENAI_AZURE_DEPLOYMENT_ID - OpenAI deployment ID for Azure (Example: my-deployment-id)
|
2023-04-12 17:17:34 +00:00
|
|
|
# OPENAI_AZURE_CHAT_DEPLOYMENT_ID - OpenAI deployment ID for Azure Chat (Example: my-deployment-id-for-azure-chat)
|
|
|
|
|
# OPENAI_AZURE_EMBEDDINGS_DEPLOYMENT_ID - OpenAI deployment ID for Embedding (Example: my-deployment-id-for-azure-embeddigs)
|
2023-04-13 16:13:32 +00:00
|
|
|
OPENAI_AZURE_API_BASE=your-base-url-for-azure
|
|
|
|
|
OPENAI_AZURE_API_VERSION=api-version-for-azure
|
|
|
|
|
OPENAI_AZURE_DEPLOYMENT_ID=deployment-id-for-azure
|
|
|
|
|
OPENAI_AZURE_CHAT_DEPLOYMENT_ID=deployment-id-for-azure-chat
|
2023-04-11 09:21:46 +00:00
|
|
|
OPENAI_AZURE_EMBEDDINGS_DEPLOYMENT_ID=deployment-id-for-azure-embeddigs
|
Improve .env File Organization, Readability, and Documentation
This pull request aims to enhance the organization, readability, and understanding of the .env.template file for users when they modify the settings. The changes include organizing the file in a tree-like structure with appropriate comments, providing clear guidance for users about the purpose of each variable, their possible values, and default settings when applicable.
As a user with no prior knowledge of best practices of contributing to a project / .env.template file documentation, I took the liberty to make changes to the file based on what I would have liked to have seen when I first encountered it. My goal was to include every configurable option for ease of use and better understanding of how the code works.
The key improvements made in this pull request are:
1. Grouping related variables under appropriate headers for better organization and ease of navigation.
2. Adding informative comments for each variable to help users understand their purpose and possible values.
3. Including default values in the comments to inform users of the consequences of not providing a specific value for a variable, allowing them to make
informed decisions when configuring the application.
4. Formatting the file consistently for better readability.
These changes will enhance user experience by simplifying the configuration process and reducing potential confusion. Users can quickly and easily configure the application without having to search through the code to determine default values or understand the relationship between various settings. Additionally, well-organized code and documentation can lead to fewer issues and misunderstandings, saving time for both users and maintainers of the project.
Please review these changes and let me know if you have any questions or suggestions for further improvement so I can make any necessary adjustments.
2023-04-12 16:54:10 +00:00
|
|
|
|
|
|
|
|
################################################################################
|
|
|
|
|
### LLM MODELS
|
|
|
|
|
################################################################################
|
|
|
|
|
|
|
|
|
|
# SMART_LLM_MODEL - Smart language model (Default: gpt-4)
|
|
|
|
|
# FAST_LLM_MODEL - Fast language model (Default: gpt-3.5-turbo)
|
2023-04-10 13:17:56 +00:00
|
|
|
SMART_LLM_MODEL=gpt-4
|
Improve .env File Organization, Readability, and Documentation
This pull request aims to enhance the organization, readability, and understanding of the .env.template file for users when they modify the settings. The changes include organizing the file in a tree-like structure with appropriate comments, providing clear guidance for users about the purpose of each variable, their possible values, and default settings when applicable.
As a user with no prior knowledge of best practices of contributing to a project / .env.template file documentation, I took the liberty to make changes to the file based on what I would have liked to have seen when I first encountered it. My goal was to include every configurable option for ease of use and better understanding of how the code works.
The key improvements made in this pull request are:
1. Grouping related variables under appropriate headers for better organization and ease of navigation.
2. Adding informative comments for each variable to help users understand their purpose and possible values.
3. Including default values in the comments to inform users of the consequences of not providing a specific value for a variable, allowing them to make
informed decisions when configuring the application.
4. Formatting the file consistently for better readability.
These changes will enhance user experience by simplifying the configuration process and reducing potential confusion. Users can quickly and easily configure the application without having to search through the code to determine default values or understand the relationship between various settings. Additionally, well-organized code and documentation can lead to fewer issues and misunderstandings, saving time for both users and maintainers of the project.
Please review these changes and let me know if you have any questions or suggestions for further improvement so I can make any necessary adjustments.
2023-04-12 16:54:10 +00:00
|
|
|
FAST_LLM_MODEL=gpt-3.5-turbo
|
|
|
|
|
|
|
|
|
|
### LLM MODEL SETTINGS
|
|
|
|
|
# FAST_TOKEN_LIMIT - Fast token limit for OpenAI (Default: 4000)
|
|
|
|
|
# SMART_TOKEN_LIMIT - Smart token limit for OpenAI (Default: 8000)
|
2023-04-13 16:13:32 +00:00
|
|
|
# When using --gpt3onlythis needs to be set to 4000.
|
|
|
|
|
FAST_TOKEN_LIMIT=4000
|
Improve .env File Organization, Readability, and Documentation
This pull request aims to enhance the organization, readability, and understanding of the .env.template file for users when they modify the settings. The changes include organizing the file in a tree-like structure with appropriate comments, providing clear guidance for users about the purpose of each variable, their possible values, and default settings when applicable.
As a user with no prior knowledge of best practices of contributing to a project / .env.template file documentation, I took the liberty to make changes to the file based on what I would have liked to have seen when I first encountered it. My goal was to include every configurable option for ease of use and better understanding of how the code works.
The key improvements made in this pull request are:
1. Grouping related variables under appropriate headers for better organization and ease of navigation.
2. Adding informative comments for each variable to help users understand their purpose and possible values.
3. Including default values in the comments to inform users of the consequences of not providing a specific value for a variable, allowing them to make
informed decisions when configuring the application.
4. Formatting the file consistently for better readability.
These changes will enhance user experience by simplifying the configuration process and reducing potential confusion. Users can quickly and easily configure the application without having to search through the code to determine default values or understand the relationship between various settings. Additionally, well-organized code and documentation can lead to fewer issues and misunderstandings, saving time for both users and maintainers of the project.
Please review these changes and let me know if you have any questions or suggestions for further improvement so I can make any necessary adjustments.
2023-04-12 16:54:10 +00:00
|
|
|
SMART_TOKEN_LIMIT=8000
|
|
|
|
|
|
|
|
|
|
################################################################################
|
|
|
|
|
### MEMORY
|
|
|
|
|
################################################################################
|
|
|
|
|
|
|
|
|
|
# MEMORY_BACKEND - Memory backend type (Default: local)
|
2023-04-12 17:17:34 +00:00
|
|
|
MEMORY_BACKEND=local
|
Improve .env File Organization, Readability, and Documentation
This pull request aims to enhance the organization, readability, and understanding of the .env.template file for users when they modify the settings. The changes include organizing the file in a tree-like structure with appropriate comments, providing clear guidance for users about the purpose of each variable, their possible values, and default settings when applicable.
As a user with no prior knowledge of best practices of contributing to a project / .env.template file documentation, I took the liberty to make changes to the file based on what I would have liked to have seen when I first encountered it. My goal was to include every configurable option for ease of use and better understanding of how the code works.
The key improvements made in this pull request are:
1. Grouping related variables under appropriate headers for better organization and ease of navigation.
2. Adding informative comments for each variable to help users understand their purpose and possible values.
3. Including default values in the comments to inform users of the consequences of not providing a specific value for a variable, allowing them to make
informed decisions when configuring the application.
4. Formatting the file consistently for better readability.
These changes will enhance user experience by simplifying the configuration process and reducing potential confusion. Users can quickly and easily configure the application without having to search through the code to determine default values or understand the relationship between various settings. Additionally, well-organized code and documentation can lead to fewer issues and misunderstandings, saving time for both users and maintainers of the project.
Please review these changes and let me know if you have any questions or suggestions for further improvement so I can make any necessary adjustments.
2023-04-12 16:54:10 +00:00
|
|
|
|
|
|
|
|
### PINECONE
|
|
|
|
|
# PINECONE_API_KEY - Pinecone API Key (Example: my-pinecone-api-key)
|
|
|
|
|
# PINECONE_ENV - Pinecone environment (region) (Example: us-west-2)
|
2023-04-13 16:13:32 +00:00
|
|
|
PINECONE_API_KEY=your-pinecone-api-key
|
Improve .env File Organization, Readability, and Documentation
This pull request aims to enhance the organization, readability, and understanding of the .env.template file for users when they modify the settings. The changes include organizing the file in a tree-like structure with appropriate comments, providing clear guidance for users about the purpose of each variable, their possible values, and default settings when applicable.
As a user with no prior knowledge of best practices of contributing to a project / .env.template file documentation, I took the liberty to make changes to the file based on what I would have liked to have seen when I first encountered it. My goal was to include every configurable option for ease of use and better understanding of how the code works.
The key improvements made in this pull request are:
1. Grouping related variables under appropriate headers for better organization and ease of navigation.
2. Adding informative comments for each variable to help users understand their purpose and possible values.
3. Including default values in the comments to inform users of the consequences of not providing a specific value for a variable, allowing them to make
informed decisions when configuring the application.
4. Formatting the file consistently for better readability.
These changes will enhance user experience by simplifying the configuration process and reducing potential confusion. Users can quickly and easily configure the application without having to search through the code to determine default values or understand the relationship between various settings. Additionally, well-organized code and documentation can lead to fewer issues and misunderstandings, saving time for both users and maintainers of the project.
Please review these changes and let me know if you have any questions or suggestions for further improvement so I can make any necessary adjustments.
2023-04-12 16:54:10 +00:00
|
|
|
PINECONE_ENV=your-pinecone-region
|
|
|
|
|
|
|
|
|
|
### REDIS
|
|
|
|
|
# REDIS_HOST - Redis host (Default: localhost)
|
|
|
|
|
# REDIS_PORT - Redis port (Default: 6379)
|
|
|
|
|
# REDIS_PASSWORD - Redis password (Default: "")
|
2023-04-12 18:40:05 +00:00
|
|
|
# WIPE_REDIS_ON_START - Wipes data / index on start (Default: False)
|
|
|
|
|
# MEMORY_INDEX - Name of index created in Redis database (Default: auto-gpt)
|
2023-04-13 16:13:32 +00:00
|
|
|
REDIS_HOST=localhost
|
|
|
|
|
REDIS_PORT=6379
|
|
|
|
|
REDIS_PASSWORD=
|
|
|
|
|
WIPE_REDIS_ON_START=False
|
2023-04-12 18:40:05 +00:00
|
|
|
MEMORY_INDEX=auto-gpt
|
Improve .env File Organization, Readability, and Documentation
This pull request aims to enhance the organization, readability, and understanding of the .env.template file for users when they modify the settings. The changes include organizing the file in a tree-like structure with appropriate comments, providing clear guidance for users about the purpose of each variable, their possible values, and default settings when applicable.
As a user with no prior knowledge of best practices of contributing to a project / .env.template file documentation, I took the liberty to make changes to the file based on what I would have liked to have seen when I first encountered it. My goal was to include every configurable option for ease of use and better understanding of how the code works.
The key improvements made in this pull request are:
1. Grouping related variables under appropriate headers for better organization and ease of navigation.
2. Adding informative comments for each variable to help users understand their purpose and possible values.
3. Including default values in the comments to inform users of the consequences of not providing a specific value for a variable, allowing them to make
informed decisions when configuring the application.
4. Formatting the file consistently for better readability.
These changes will enhance user experience by simplifying the configuration process and reducing potential confusion. Users can quickly and easily configure the application without having to search through the code to determine default values or understand the relationship between various settings. Additionally, well-organized code and documentation can lead to fewer issues and misunderstandings, saving time for both users and maintainers of the project.
Please review these changes and let me know if you have any questions or suggestions for further improvement so I can make any necessary adjustments.
2023-04-12 16:54:10 +00:00
|
|
|
|
|
|
|
|
################################################################################
|
|
|
|
|
### IMAGE GENERATION PROVIDER
|
|
|
|
|
################################################################################
|
|
|
|
|
|
|
|
|
|
### OPEN AI
|
|
|
|
|
# IMAGE_PROVIDER - Image provider (Example: dalle)
|
2023-04-07 18:29:43 +00:00
|
|
|
IMAGE_PROVIDER=dalle
|
Improve .env File Organization, Readability, and Documentation
This pull request aims to enhance the organization, readability, and understanding of the .env.template file for users when they modify the settings. The changes include organizing the file in a tree-like structure with appropriate comments, providing clear guidance for users about the purpose of each variable, their possible values, and default settings when applicable.
As a user with no prior knowledge of best practices of contributing to a project / .env.template file documentation, I took the liberty to make changes to the file based on what I would have liked to have seen when I first encountered it. My goal was to include every configurable option for ease of use and better understanding of how the code works.
The key improvements made in this pull request are:
1. Grouping related variables under appropriate headers for better organization and ease of navigation.
2. Adding informative comments for each variable to help users understand their purpose and possible values.
3. Including default values in the comments to inform users of the consequences of not providing a specific value for a variable, allowing them to make
informed decisions when configuring the application.
4. Formatting the file consistently for better readability.
These changes will enhance user experience by simplifying the configuration process and reducing potential confusion. Users can quickly and easily configure the application without having to search through the code to determine default values or understand the relationship between various settings. Additionally, well-organized code and documentation can lead to fewer issues and misunderstandings, saving time for both users and maintainers of the project.
Please review these changes and let me know if you have any questions or suggestions for further improvement so I can make any necessary adjustments.
2023-04-12 16:54:10 +00:00
|
|
|
|
|
|
|
|
### HUGGINGFACE
|
2023-04-13 16:13:32 +00:00
|
|
|
# STABLE DIFFUSION
|
|
|
|
|
# (Default URL: https://api-inference.huggingface.co/models/CompVis/stable-diffusion-v1-4)
|
Improve .env File Organization, Readability, and Documentation
This pull request aims to enhance the organization, readability, and understanding of the .env.template file for users when they modify the settings. The changes include organizing the file in a tree-like structure with appropriate comments, providing clear guidance for users about the purpose of each variable, their possible values, and default settings when applicable.
As a user with no prior knowledge of best practices of contributing to a project / .env.template file documentation, I took the liberty to make changes to the file based on what I would have liked to have seen when I first encountered it. My goal was to include every configurable option for ease of use and better understanding of how the code works.
The key improvements made in this pull request are:
1. Grouping related variables under appropriate headers for better organization and ease of navigation.
2. Adding informative comments for each variable to help users understand their purpose and possible values.
3. Including default values in the comments to inform users of the consequences of not providing a specific value for a variable, allowing them to make
informed decisions when configuring the application.
4. Formatting the file consistently for better readability.
These changes will enhance user experience by simplifying the configuration process and reducing potential confusion. Users can quickly and easily configure the application without having to search through the code to determine default values or understand the relationship between various settings. Additionally, well-organized code and documentation can lead to fewer issues and misunderstandings, saving time for both users and maintainers of the project.
Please review these changes and let me know if you have any questions or suggestions for further improvement so I can make any necessary adjustments.
2023-04-12 16:54:10 +00:00
|
|
|
# Set in image_gen.py)
|
|
|
|
|
# HUGGINGFACE_API_TOKEN - HuggingFace API token (Example: my-huggingface-api-token)
|
2023-04-13 16:13:32 +00:00
|
|
|
HUGGINGFACE_API_TOKEN=your-huggingface-api-token
|
Improve .env File Organization, Readability, and Documentation
This pull request aims to enhance the organization, readability, and understanding of the .env.template file for users when they modify the settings. The changes include organizing the file in a tree-like structure with appropriate comments, providing clear guidance for users about the purpose of each variable, their possible values, and default settings when applicable.
As a user with no prior knowledge of best practices of contributing to a project / .env.template file documentation, I took the liberty to make changes to the file based on what I would have liked to have seen when I first encountered it. My goal was to include every configurable option for ease of use and better understanding of how the code works.
The key improvements made in this pull request are:
1. Grouping related variables under appropriate headers for better organization and ease of navigation.
2. Adding informative comments for each variable to help users understand their purpose and possible values.
3. Including default values in the comments to inform users of the consequences of not providing a specific value for a variable, allowing them to make
informed decisions when configuring the application.
4. Formatting the file consistently for better readability.
These changes will enhance user experience by simplifying the configuration process and reducing potential confusion. Users can quickly and easily configure the application without having to search through the code to determine default values or understand the relationship between various settings. Additionally, well-organized code and documentation can lead to fewer issues and misunderstandings, saving time for both users and maintainers of the project.
Please review these changes and let me know if you have any questions or suggestions for further improvement so I can make any necessary adjustments.
2023-04-12 16:54:10 +00:00
|
|
|
|
|
|
|
|
################################################################################
|
|
|
|
|
### SEARCH PROVIDER
|
|
|
|
|
################################################################################
|
|
|
|
|
|
|
|
|
|
### GOOGLE
|
|
|
|
|
# GOOGLE_API_KEY - Google API key (Example: my-google-api-key)
|
|
|
|
|
# CUSTOM_SEARCH_ENGINE_ID - Custom search engine ID (Example: my-custom-search-engine-id)
|
2023-04-13 16:13:32 +00:00
|
|
|
GOOGLE_API_KEY=your-google-api-key
|
|
|
|
|
CUSTOM_SEARCH_ENGINE_ID=your-custom-search-engine-id
|
Improve .env File Organization, Readability, and Documentation
This pull request aims to enhance the organization, readability, and understanding of the .env.template file for users when they modify the settings. The changes include organizing the file in a tree-like structure with appropriate comments, providing clear guidance for users about the purpose of each variable, their possible values, and default settings when applicable.
As a user with no prior knowledge of best practices of contributing to a project / .env.template file documentation, I took the liberty to make changes to the file based on what I would have liked to have seen when I first encountered it. My goal was to include every configurable option for ease of use and better understanding of how the code works.
The key improvements made in this pull request are:
1. Grouping related variables under appropriate headers for better organization and ease of navigation.
2. Adding informative comments for each variable to help users understand their purpose and possible values.
3. Including default values in the comments to inform users of the consequences of not providing a specific value for a variable, allowing them to make
informed decisions when configuring the application.
4. Formatting the file consistently for better readability.
These changes will enhance user experience by simplifying the configuration process and reducing potential confusion. Users can quickly and easily configure the application without having to search through the code to determine default values or understand the relationship between various settings. Additionally, well-organized code and documentation can lead to fewer issues and misunderstandings, saving time for both users and maintainers of the project.
Please review these changes and let me know if you have any questions or suggestions for further improvement so I can make any necessary adjustments.
2023-04-12 16:54:10 +00:00
|
|
|
|
|
|
|
|
################################################################################
|
|
|
|
|
### TTS PROVIDER
|
|
|
|
|
################################################################################
|
|
|
|
|
|
|
|
|
|
### MAC OS
|
|
|
|
|
# USE_MAC_OS_TTS - Use Mac OS TTS or not (Default: False)
|
2023-04-12 05:05:07 +00:00
|
|
|
USE_MAC_OS_TTS=False
|
Improve .env File Organization, Readability, and Documentation
This pull request aims to enhance the organization, readability, and understanding of the .env.template file for users when they modify the settings. The changes include organizing the file in a tree-like structure with appropriate comments, providing clear guidance for users about the purpose of each variable, their possible values, and default settings when applicable.
As a user with no prior knowledge of best practices of contributing to a project / .env.template file documentation, I took the liberty to make changes to the file based on what I would have liked to have seen when I first encountered it. My goal was to include every configurable option for ease of use and better understanding of how the code works.
The key improvements made in this pull request are:
1. Grouping related variables under appropriate headers for better organization and ease of navigation.
2. Adding informative comments for each variable to help users understand their purpose and possible values.
3. Including default values in the comments to inform users of the consequences of not providing a specific value for a variable, allowing them to make
informed decisions when configuring the application.
4. Formatting the file consistently for better readability.
These changes will enhance user experience by simplifying the configuration process and reducing potential confusion. Users can quickly and easily configure the application without having to search through the code to determine default values or understand the relationship between various settings. Additionally, well-organized code and documentation can lead to fewer issues and misunderstandings, saving time for both users and maintainers of the project.
Please review these changes and let me know if you have any questions or suggestions for further improvement so I can make any necessary adjustments.
2023-04-12 16:54:10 +00:00
|
|
|
|
|
|
|
|
### ELEVENLABS
|
|
|
|
|
# ELEVENLABS_API_KEY - Eleven Labs API key (Example: my-elevenlabs-api-key)
|
|
|
|
|
# ELEVENLABS_VOICE_1_ID - Eleven Labs voice 1 ID (Example: my-voice-id-1)
|
|
|
|
|
# ELEVENLABS_VOICE_2_ID - Eleven Labs voice 2 ID (Example: my-voice-id-2)
|
2023-04-13 16:13:32 +00:00
|
|
|
ELEVENLABS_API_KEY=your-elevenlabs-api-key
|
|
|
|
|
ELEVENLABS_VOICE_1_ID=your-voice-id-1
|
|
|
|
|
ELEVENLABS_VOICE_2_ID=your-voice-id-2
|
