Document how to run Synapse (#15022)
* Document how to run Synapse * Changelog for 15022 * Update docs/development/contributing_guide.mdpull/15026/head
							parent
							
								
									dccae64083
								
							
						
					
					
						commit
						a4126e2861
					
				| 
						 | 
				
			
			@ -0,0 +1 @@
 | 
			
		|||
Document how to start Synapse in the contributing guide.
 | 
			
		||||
| 
						 | 
				
			
			@ -78,6 +78,19 @@ poetry install --extras all
 | 
			
		|||
 | 
			
		||||
This will install the runtime and developer dependencies for the project.
 | 
			
		||||
 | 
			
		||||
## Running Synapse via poetry
 | 
			
		||||
 | 
			
		||||
To start a local instance of Synapse in the locked poetry environment, create a config file:
 | 
			
		||||
 | 
			
		||||
```sh
 | 
			
		||||
cp docs/sample_config.yaml homeserver.yaml
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Now edit homeserver.yaml, and run Synapse with:
 | 
			
		||||
 | 
			
		||||
```sh
 | 
			
		||||
poetry run python -m synapse.app.homeserver -c homeserver.yaml
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
# 5. Get in touch.
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
		Reference in New Issue