admin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Simplify docs and remove Docker local setup (#4783)

Browse Source 
Having 2 different dev setups caused confusion, let's remove the Docker
local setup and recommend people install yarn locally.

Also simplified some docs by merging pages together, the recommend
self-hosting option is now the docker-compose / to adapt the
docker-compose.
This commit is contained in:
Félix Malfait
2024-04-03 16:38:28 +02:00
committed by GitHub
parent 1c6f0eb577
commit 7a34dc4910
24 changed files with 41 additions and 265 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
packages/twenty-docs/docs/start/self-hosting/1-click-deploy.mdx
View File

@ -1,24 +0,0 @@
---
title: 1-Click Deploy
sidebar_position: 1
sidebar_custom_props:
icon: TbBolt
---
## Render
[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/twentyhq/twenty)
## RepoCloud
[![Deploy on RepoCloud](https://d16t0pc4846x52.cloudfront.net/deploy.png)](https://repocloud.io/details/?app_id=259)
## Digital Ocean
Community contribution are welcome!
## Other
Please feel free to Open a PR to add more 1-Click Deploy options.

15
packages/twenty-docs/docs/start/self-hosting/cloud-providers.mdx
View File

@ -1,6 +1,6 @@
---
title: Cloud providers
sidebar_position: 2
title: Vendor-specific instructions
sidebar_position: 3
sidebar_custom_props:
icon: TbCloud
---
@ -10,10 +10,15 @@ This document is maintained by the community. It might contain issues.
Feel free to join our discord if you need assistance.
:::
## Available cloud providers
- [Azure Container Apps](#azure-container-apps)
- [Others](#others)
## Render
[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/twentyhq/twenty)
## RepoCloud
[![Deploy on RepoCloud](https://d16t0pc4846x52.cloudfront.net/deploy.png)](https://repocloud.io/details/?app_id=259)
## Azure Container Apps

10
packages/twenty-docs/docs/start/self-hosting/docker-compose.mdx
View File

@ -1,6 +1,6 @@
---
title: Docker Compose
sidebar_position: 3
title: Docker Compose (easy)
sidebar_position: 2
sidebar_custom_props:
icon: TbBrandDocker
---
@ -17,12 +17,12 @@ bash <(curl -sL https://git.new/20)
Set VERSION for a specific docker image version, BRANCH for a specific clone branch:
```bash
VERSION=x.y.z BRANCH=branch-name bash <(curl -sL https://raw.githubusercontent.com/twentyhq/twenty/main/install.sh)
VERSION=x.y.z BRANCH=branch-name bash <(curl -sL https://git.new/20)
```
## Manual installation
1. Copy the [.env.example](https://github.com/twentyhq/twenty/blob/main/packages/twenty-docker/prod/.env.example) into a `.env` in the same directory where your `docker-compose.yml` file will be
1. Copy the [.env.example](https://github.com/twentyhq/twenty/blob/main/packages/twenty-docker/.env.example) into a `.env` in the same directory where your `docker-compose.yml` file will be
2. Run the command `openssl rand -base64 32` three times, make note of the string for each
3. In your .env file, replace the three "replace_me_with_a_random_string_access" with the three random strings you just generated.
@ -33,7 +33,7 @@ REFRESH_TOKEN_SECRET=replace_me_with_a_random_string_refresh
FILE_TOKEN_SECRET=replace_me_with_a_random_string_refresh
```
4. Copy the [docker-compose.yml](https://github.com/twentyhq/twenty/blob/main/packages/twenty-docker/prod/docker-compose.yml) in the same directory as your `.env` file.
4. Copy the [docker-compose.yml](https://github.com/twentyhq/twenty/blob/main/packages/twenty-docker/docker-compose.yml) in the same directory as your `.env` file.
5. Run the command `docker-compose up -d`
6. Go to http://localhost:3000 and see your docker instance.