|
1 | | -<div align="center" style="padding: 10px; border: 1px solid #ccc; background-color: #f9f9f9; border-radius: 10px; margin-bottom: 20px;"> |
2 | | - <h2 style="margin: 0; font-size: 24px; color: #333;">Langflow 1.0 is OUT! 🎉</h2> |
3 | | - <p style="margin: 5px 0 0 0; font-size: 16px; color: #666;">Read all about it <a href="https://medium.com/p/73d3bdce8440" style="text-decoration: underline; color: #1a73e8;">here</a>!</p> |
4 | | -</div> |
5 | 1 |
|
6 | 2 | <!-- markdownlint-disable MD030 --> |
7 | 3 |
|
8 | | -# [](https://www.langflow.org) |
| 4 | +# RAGStack Langflow |
9 | 5 |
|
10 | | -<p align="center"><strong> |
11 | | - A visual framework for building multi-agent and RAG applications |
12 | | -</strong></p> |
13 | | -<p align="center" style="font-size: 12px;"> |
14 | | - Open-source, Python-powered, fully customizable, LLM and vector store agnostic |
15 | | -</p> |
| 6 | +## Documentation |
16 | 7 |
|
17 | | -<p align="center" style="font-size: 12px;"> |
18 | | - <a href="https://docs.langflow.org" style="text-decoration: underline;">Docs</a> - |
19 | | - <a href="https://discord.com/invite/EqksyE2EX9" style="text-decoration: underline;">Join our Discord</a> - |
20 | | - <a href="https://twitter.com/langflow_ai" style="text-decoration: underline;">Follow us on X</a> - |
21 | | - <a href="https://huggingface.co/spaces/Langflow/Langflow-Preview" style="text-decoration: underline;">Live demo</a> |
22 | | -</p> |
| 8 | +[DataStax RAGStack Documentation](https://docs.datastax.com/en/ragstack/docs/index.html) |
23 | 9 |
|
24 | | -<p align="center"> |
25 | | - <a href="https://github.com/langflow-ai/langflow"> |
26 | | - <img src="https://img.shields.io/github/stars/langflow-ai/langflow"> |
27 | | - </a> |
28 | | - <a href="https://discord.com/invite/EqksyE2EX9"> |
29 | | - <img src="https://img.shields.io/discord/1116803230643527710?label=Discord"> |
30 | | - </a> |
31 | | -</p> |
| 10 | +## 📄 License |
32 | 11 |
|
33 | | -<div align="center"> |
34 | | - <a href="./README.md"><img alt="README in English" src="https://img.shields.io/badge/English-d9d9d9"></a> |
35 | | - <a href="./README.PT.md"><img alt="README in Portuguese" src="https://img.shields.io/badge/Portuguese-d9d9d9"></a> |
36 | | - <a href="./README.zh_CN.md"><img alt="README in Simplified Chinese" src="https://img.shields.io/badge/简体中文-d9d9d9"></a> |
37 | | -</div> |
| 12 | +RAGStack Langflow is released under the BUSL License. See the [LICENSE](LICENSE.md) file for details. |
38 | 13 |
|
39 | | -<p align="center"> |
40 | | - <img src="./docs/static/img/langflow_basic_howto.gif" alt="Your GIF" style="border: 3px solid #211C43;"> |
41 | | -</p> |
42 | | - |
43 | | -# 📝 Content |
44 | | - |
45 | | -- [](#) |
46 | | -- [📝 Content](#-content) |
47 | | -- [📦 Get Started](#-get-started) |
48 | | -- [🎨 Create Flows](#-create-flows) |
49 | | -- [Deploy](#deploy) |
50 | | - - [Deploy Langflow on Google Cloud Platform](#deploy-langflow-on-google-cloud-platform) |
51 | | - - [Deploy on Railway](#deploy-on-railway) |
52 | | - - [Deploy on Render](#deploy-on-render) |
53 | | - - [Deploy on Kubernetes](#deploy-on-kubernetes) |
54 | | -- [🖥️ Command Line Interface (CLI)](#️-command-line-interface-cli) |
55 | | - - [Usage](#usage) |
56 | | - - [Environment Variables](#environment-variables) |
57 | | -- [👋 Contribute](#-contribute) |
58 | | -- [🌟 Contributors](#-contributors) |
59 | | -- [📄 License](#-license) |
60 | | - |
61 | | -# 📦 Get Started |
62 | | - |
63 | | -You can install Langflow with pip: |
64 | | - |
65 | | -```shell |
66 | | -# Make sure you have >=Python 3.10 installed on your system. |
67 | | -python -m pip install langflow -U |
68 | | -``` |
69 | | - |
70 | | -Then, run Langflow with: |
71 | | - |
72 | | -```shell |
73 | | -python -m langflow run |
74 | | -``` |
75 | | - |
76 | | -# 🎨 Create Flows |
77 | | - |
78 | | -Creating flows with Langflow is easy. Simply drag components from the sidebar onto the workspace and connect them to start building your application. |
79 | | - |
80 | | -Explore by editing prompt parameters, grouping components into a single high-level component, and building your own Custom Components. |
81 | | - |
82 | | -Once you’re done, you can export your flow as a JSON file. |
83 | | - |
84 | | -Load the flow with: |
85 | | - |
86 | | -```python |
87 | | -from langflow.load import run_flow_from_json |
88 | | - |
89 | | -results = run_flow_from_json("path/to/flow.json", input_value="Hello, World!") |
90 | | -``` |
91 | | - |
92 | | -# Deploy |
93 | | - |
94 | | -## DataStax Langflow |
95 | | -DataStax Langflow is a hosted version of Langflow integrated with [AstraDB](https://www.datastax.com/products/datastax-astra). Be up and running in minutes with no installation or setup required. [Sign up for free](https://langflow.datastax.com). |
96 | | - |
97 | | -## Deploy Langflow on Hugging Face Spaces |
98 | | -You can also preview Langflow in [HuggingFace Spaces](https://huggingface.co/spaces/Langflow/Langflow-Preview). [Clone the space using this link](https://huggingface.co/spaces/Langflow/Langflow-Preview?duplicate=true) to create your own Langflow workspace in minutes. |
99 | | - |
100 | | -## Deploy Langflow on Google Cloud Platform |
101 | | - |
102 | | -Follow our step-by-step guide to deploy Langflow on Google Cloud Platform (GCP) using Google Cloud Shell. The guide is available in the [**Langflow in Google Cloud Platform**](https://github.com/langflow-ai/langflow/blob/dev/docs/docs/deployment/gcp-deployment.md) document. |
103 | | - |
104 | | -Alternatively, click the **"Open in Cloud Shell"** button below to launch Google Cloud Shell, clone the Langflow repository, and start an **interactive tutorial** that will guide you through the process of setting up the necessary resources and deploying Langflow on your GCP project. |
105 | | - |
106 | | -[](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/langflow-ai/langflow&working_dir=scripts/gcp&shellonly=true&tutorial=walkthroughtutorial_spot.md) |
107 | | - |
108 | | -## Deploy on Railway |
109 | | - |
110 | | -Use this template to deploy Langflow 1.0 on Railway: |
111 | | - |
112 | | -[](https://railway.app/template/JMXEWp?referralCode=MnPSdg) |
113 | | - |
114 | | -## Deploy on Render |
115 | | - |
116 | | -<a href="https://render.com/deploy?repo=https://github.com/langflow-ai/langflow/tree/dev"> |
117 | | -<img src="https://render.com/images/deploy-to-render-button.svg" alt="Deploy to Render" /> |
118 | | -</a> |
119 | | - |
120 | | -## Deploy on Kubernetes |
121 | | - |
122 | | -Follow our step-by-step guide to deploy [Langflow on Kubernetes](https://github.com/langflow-ai/langflow/blob/dev/docs/docs/deployment/kubernetes.md). |
123 | | - |
124 | | - |
125 | | -# 🖥️ Command Line Interface (CLI) |
126 | | - |
127 | | -Langflow provides a command-line interface (CLI) for easy management and configuration. |
128 | | - |
129 | | -## Usage |
130 | | - |
131 | | -You can run the Langflow using the following command: |
132 | | - |
133 | | -```shell |
134 | | -langflow run [OPTIONS] |
135 | | -``` |
136 | | - |
137 | | -Each option is detailed below: |
138 | | - |
139 | | -- `--help`: Displays all available options. |
140 | | -- `--host`: Defines the host to bind the server to. Can be set using the `LANGFLOW_HOST` environment variable. The default is `127.0.0.1`. |
141 | | -- `--workers`: Sets the number of worker processes. Can be set using the `LANGFLOW_WORKERS` environment variable. The default is `1`. |
142 | | -- `--timeout`: Sets the worker timeout in seconds. The default is `60`. |
143 | | -- `--port`: Sets the port to listen on. Can be set using the `LANGFLOW_PORT` environment variable. The default is `7860`. |
144 | | -- `--env-file`: Specifies the path to the .env file containing environment variables. The default is `.env`. |
145 | | -- `--log-level`: Defines the logging level. Can be set using the `LANGFLOW_LOG_LEVEL` environment variable. The default is `critical`. |
146 | | -- `--components-path`: Specifies the path to the directory containing custom components. Can be set using the `LANGFLOW_COMPONENTS_PATH` environment variable. The default is `langflow/components`. |
147 | | -- `--log-file`: Specifies the path to the log file. Can be set using the `LANGFLOW_LOG_FILE` environment variable. The default is `logs/langflow.log`. |
148 | | -- `--cache`: Selects the type of cache to use. Options are `InMemoryCache` and `SQLiteCache`. Can be set using the `LANGFLOW_LANGCHAIN_CACHE` environment variable. The default is `SQLiteCache`. |
149 | | -- `--dev/--no-dev`: Toggles the development mode. The default is `no-dev`. |
150 | | -- `--path`: Specifies the path to the frontend directory containing build files. This option is for development purposes only. Can be set using the `LANGFLOW_FRONTEND_PATH` environment variable. |
151 | | -- `--open-browser/--no-open-browser`: Toggles the option to open the browser after starting the server. Can be set using the `LANGFLOW_OPEN_BROWSER` environment variable. The default is `open-browser`. |
152 | | -- `--remove-api-keys/--no-remove-api-keys`: Toggles the option to remove API keys from the projects saved in the database. Can be set using the `LANGFLOW_REMOVE_API_KEYS` environment variable. The default is `no-remove-api-keys`. |
153 | | -- `--install-completion [bash|zsh|fish|powershell|pwsh]`: Installs completion for the specified shell. |
154 | | -- `--show-completion [bash|zsh|fish|powershell|pwsh]`: Shows completion for the specified shell, allowing you to copy it or customize the installation. |
155 | | -- `--backend-only`: This parameter, with a default value of `False`, allows running only the backend server without the frontend. It can also be set using the `LANGFLOW_BACKEND_ONLY` environment variable. |
156 | | -- `--store`: This parameter, with a default value of `True`, enables the store features, use `--no-store` to deactivate it. It can be configured using the `LANGFLOW_STORE` environment variable. |
157 | | - |
158 | | -These parameters are important for users who need to customize the behavior of Langflow, especially in development or specialized deployment scenarios. |
159 | | - |
160 | | -### Environment Variables |
161 | | - |
162 | | -You can configure many of the CLI options using environment variables. These can be exported in your operating system or added to a `.env` file and loaded using the `--env-file` option. |
163 | | - |
164 | | -A sample `.env` file named `.env.example` is included with the project. Copy this file to a new file named `.env` and replace the example values with your actual settings. If you're setting values in both your OS and the `.env` file, the `.env` settings will take precedence. |
165 | | - |
166 | | -# 👋 Contribute |
167 | | - |
168 | | -We welcome contributions from developers of all levels to our open-source project on GitHub. If you'd like to contribute, please check our [contributing guidelines](./CONTRIBUTING.md) and help make Langflow more accessible. |
169 | | - |
170 | | ---- |
171 | | - |
172 | | -[](https://star-history.com/#langflow-ai/langflow&Date) |
173 | | - |
174 | | -# 🌟 Contributors |
175 | | - |
176 | | -[](https://github.com/langflow-ai/langflow/graphs/contributors) |
177 | | - |
178 | | -# 📄 License |
179 | | - |
180 | | -Langflow is released under the MIT License. See the [LICENSE](LICENSE) file for details. |
0 commit comments