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

Doc: Update the synapse installation section with poetry usage #7521

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

manuroe
Copy link
Member

@manuroe manuroe commented Nov 4, 2022

Type of change

  • Feature
  • Bugfix
  • Technical
  • Other : Doc update

Content

Update the synapse installation doc to set up a local synapse locally for integration tests or dev.

@manuroe manuroe force-pushed the bugfix/manu/synapse_installation_doc branch from 2495484 to 1c7258e Compare November 4, 2022 10:51
@manuroe manuroe requested review from a team and ganfra and removed request for a team November 4, 2022 10:51
@sonarcloud
Copy link

sonarcloud bot commented Nov 4, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@amitkma
Copy link
Contributor

amitkma commented Nov 4, 2022

I think we should also mention that demo/start.sh should be modified from echo "public_baseurl: http://localhost:$port/ to echo "public_baseurl: http://10.0.2.2:$port/.

Otherwise the generate config has baseurl set to localhost:$port which is returned in API response. Thus emulator can't connect as it uses localhost instead of 10.0.2.2


```bash
python3 -m pip install virtualenv
pip install --user pipx
Copy link
Member

Choose a reason for hiding this comment

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

pip3 install --user pipx worked here.

pip install -e .
demo/start.sh --no-rate-limit

poetry install --extras all
Copy link
Member

Choose a reason for hiding this comment

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

  • For the error during Installing psycopg2 (2.9.5): Error: pg_config executable not found., run brew install postgresql.
  • For the error during Installing the current project: matrix-synapse (1.73.0): ModuleNotFoundError: No module named 'setuptools_rust', run pip install setuptools_rust

@@ -113,19 +106,4 @@ Ensure you have the following configuration in `demo/etc/8080.config`.
public_baseurl: http://10.0.2.2:8080/
```

After changing this you will need to restart synapse using `demo/stop.sh` and `demo/start.sh` to load the new configuration.

### virtualenv command fails
Copy link
Member

Choose a reason for hiding this comment

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

You will need to update the toc by running ./gradlew knit.


```bash
python3 -m pip install virtualenv
pip install --user pipx
pipx install poetry
Copy link
Member

Choose a reason for hiding this comment

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

Personal note, maybe mention it here: poetry 1.2 is required. Check that this is the installed version. When I run it, it installed version 1.1.13, I do not know why...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants