diff --git a/docs/deployment/railway.mdx b/docs/deployment/railway.mdx new file mode 100644 index 00000000..ef8a60ab --- /dev/null +++ b/docs/deployment/railway.mdx @@ -0,0 +1,86 @@ +--- +title: 'Railway.app' +description: 'Deploy your RAG application to railway.app' +--- + +It's easy to host your Embedchain-powered apps and APIs on railway. + +Follow the instructions given below to deploy your first application quickly: + +## Step-1: Create RAG app + +```bash Install embedchain +pip install embedchain +``` + + +**Create a full stack app using Embedchain CLI** + +To use your hosted embedchain RAG app, you can easily set up a FastAPI server that can be used anywhere. +To easily set up a FastAPI server, check out [Get started with Full stack](https://docs.embedchain.ai/get-started/full-stack) page. + +Hosting this server on railway is super easy! + + + +## Step-2: Set up your project + +### With Docker + +You can create a `Dockerfile` in the root of the project, with all the instructions. However, this method is sometimes slower in deployment. + +### Without Docker + +By default, Railway uses Python 3.7. Embedchain requires the python version to be >3.9 in order to install. + +To fix this, create a `.python-version` file in the root directory of your project and specify the correct version + +```bash .python-version +3.10 +``` + +You also need to create a `requirements.txt` file to specify the requirements. + +```bash requirements.txt +python-dotenv +embedchain +fastapi==0.108.0 +uvicorn==0.25.0 +embedchain +beautifulsoup4 +sentence-transformers +``` + +## Step-3: Deploy to Railway 🚀 + +1. Go to https://railway.app and create an account. +2. Create a project by clicking on the "Start a new project" button + +### With Github + +Select `Empty Project` or `Deploy from Github Repo`. + +You should be all set! + +### Without Github + +You can also use the railway CLI to deploy your apps from the terminal, if you don't want to connect a git repository. + +To do this, just run this command in your terminal + +```bash Install and set up railway CLI +npm i -g @railway/cli +railway login +railway link [projectID] +``` + +Finally, run `railway up` to deploy your app. +```bash Deploy +railway up +``` + +## Seeking help? + +If you run into issues with deployment, please feel free to reach out to us via any of the following methods: + + diff --git a/docs/get-started/deployment.mdx b/docs/get-started/deployment.mdx index c473d031..78c6f40e 100644 --- a/docs/get-started/deployment.mdx +++ b/docs/get-started/deployment.mdx @@ -9,6 +9,7 @@ After successfully setting up and testing your RAG app locally, the next step is + diff --git a/docs/mint.json b/docs/mint.json index f8ed1459..36d104ac 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -142,6 +142,7 @@ "deployment/fly_io", "deployment/modal_com", "deployment/render_com", + "deployment/railway", "deployment/streamlit_io", "deployment/gradio_app", "deployment/huggingface_spaces",