Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation + docker-compose.yml update #9653

Merged
merged 4 commits into from
Jan 16, 2025
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ For example, if you have a page that listens for the Enter key, and a modal that

To handle this problem, we have a custom hook that makes it possible to listen to hotkeys without any conflict.

You place it in a component and it will listen to the hotkeys only when the component is mounted AND when the specified **hotkey scope** is active.
You place it in a component, and it will listen to the hotkeys only when the component is mounted AND when the specified **hotkey scope** is active.

## How to listen for hotkeys in practice ?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

style: question mark after 'practice' is informal - consider removing


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ On the left sidebar, you can access the different pages of Twenty's Figma. This

## Useful Tips

With read-only access, you can't edit the design but you can access all features that will be useful to convert the designs into code.
With read-only access, you can't edit the design, but you can access all features that will be useful to convert the designs into code.

### Use the Dev mode

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ curl -O https://raw.githubusercontent.com/twentyhq/twenty/refs/tags/v0.35.0/pack

Start the Docker containers:
```bash
docker-compose up -d
docker compose up -d
```

### Step 4: Access the Application
Expand Down Expand Up @@ -158,8 +158,8 @@ We strongly recommend setting up Twenty behind a reverse proxy with SSL terminat

For changes to take effect, restart the Docker containers:
```bash
docker-compose down
docker-compose up -d
docker compose down
docker compose up -d
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

style: unnecessary indentation in code block - remove leading spaces

```

#### Considerations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,8 @@ If you can't log in after setup:
```
2. Restart the Docker containers:
```bash
docker-compose down
docker-compose up -d
docker compose down
docker compose up -d
```

Note the database:reset command will completely erase your database and recreate it from scratch.
Expand Down Expand Up @@ -125,7 +125,7 @@ If you encounter issues not covered in this guide:

View container logs for error messages:
```bash
docker-compose logs
docker compose logs
```

- Community Support:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ If you used Docker Compose, follow these steps:

2. Upgrade the version by changing the `TAG` value in the .env file near your docker-compose.

3. Bring Twenty back online with `docker-compose up -d`
3. Bring Twenty back online with `docker compose up -d`

If you want to upgrade your instance by few versions, e.g. from 0.33.0 to 0.35.0, you have to upgrade your instance by each version, in this example from 0.33.0 to 0.34.0, then from 0.34.0 to 0.35.0.


## Version-specific upgrade steps
Expand Down Expand Up @@ -75,6 +77,8 @@ The `yarn command:prod cache:flush` command will flush the Redis cache.
The `yarn database:migrate:prod` command will apply the migrations to the database structure (core and metadata schemas)
The `yarn command:prod upgrade-0.33` takes care of the data migration of all workspaces.

Starting from this version, twenty-postgres image for DB became deprecated and twenty-postgres-spilo is used instead.
If you want to keep using twenty-postgres image, simply replace `twentycrm/twenty-postgres:${TAG}` with `twentycrm/twenty-postgres` in docker-compose.yml.

### v0.31.0 to v0.32.0

Expand Down
Loading