mirror of
				https://github.com/zulip/zulip.git
				synced 2025-11-03 21:43:21 +00:00 
			
		
		
		
	requirements: Migrate to uv.
https://docs.astral.sh/uv/ Signed-off-by: Anders Kaseorg <anders@zulip.com>
This commit is contained in:
		
				
					committed by
					
						
						Tim Abbott
					
				
			
			
				
	
			
			
			
						parent
						
							72f5df2e09
						
					
				
				
					commit
					d7556b4060
				
			@@ -60,7 +60,7 @@ Once your remote dev instance is ready:
 | 
			
		||||
  `ssh zulipdev@<username>.zulipdev.org` on the command line
 | 
			
		||||
  (Terminal for macOS and Linux, Bash for Git on Windows).
 | 
			
		||||
- There is no password; your account is configured to use your SSH keys.
 | 
			
		||||
- Once you log in, you should see `(zulip-py3-venv) ~$`.
 | 
			
		||||
- Once you log in, you should see `(zulip-server) ~$`.
 | 
			
		||||
- To start the dev server, `cd zulip` and then run `./tools/run-dev`.
 | 
			
		||||
- While the dev server is running, you can see the Zulip server in your browser
 | 
			
		||||
  at http://zulip.username.zulipdev.org:9991.
 | 
			
		||||
 
 | 
			
		||||
@@ -54,7 +54,7 @@ Zulip and run the following commands:
 | 
			
		||||
```bash
 | 
			
		||||
# From inside a clone of zulip.git:
 | 
			
		||||
./tools/provision
 | 
			
		||||
source /srv/zulip-py3-venv/bin/activate
 | 
			
		||||
source .venv/bin/activate
 | 
			
		||||
./tools/run-dev  # starts the development server
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
@@ -212,8 +212,8 @@ expected.
 | 
			
		||||
1. Set the `EXTERNAL_HOST` environment variable.
 | 
			
		||||
 | 
			
		||||
   ```console
 | 
			
		||||
   (zulip-py3-venv) vagrant@ubuntu-18:/srv/zulip$ export EXTERNAL_HOST="$(hostname -I | xargs):9991"
 | 
			
		||||
   (zulip-py3-venv) vagrant@ubuntu-18:/srv/zulip$ echo $EXTERNAL_HOST
 | 
			
		||||
   (zulip-server) vagrant@ubuntu-18:/srv/zulip$ export EXTERNAL_HOST="$(hostname -I | xargs):9991"
 | 
			
		||||
   (zulip-server) vagrant@ubuntu-18:/srv/zulip$ echo $EXTERNAL_HOST
 | 
			
		||||
   ```
 | 
			
		||||
 | 
			
		||||
   The output will be like:
 | 
			
		||||
@@ -234,7 +234,7 @@ expected.
 | 
			
		||||
1. You should now be able to start the Zulip development server.
 | 
			
		||||
 | 
			
		||||
   ```console
 | 
			
		||||
   (zulip-py3-venv) vagrant@ubuntu-18:/srv/zulip$ ./tools/run-dev
 | 
			
		||||
   (zulip-server) vagrant@ubuntu-18:/srv/zulip$ ./tools/run-dev
 | 
			
		||||
   ```
 | 
			
		||||
 | 
			
		||||
   The output will look like:
 | 
			
		||||
 
 | 
			
		||||
@@ -293,7 +293,7 @@ simply click **Allow access**.)
 | 
			
		||||
$ # Install/update the Zulip development environment
 | 
			
		||||
$ ./tools/provision
 | 
			
		||||
$ # Enter the Zulip Python environment
 | 
			
		||||
$ source /srv/zulip-py3-venv/bin/activate
 | 
			
		||||
$ source .venv/bin/activate
 | 
			
		||||
$ # Start the development server
 | 
			
		||||
$ ./tools/run-dev
 | 
			
		||||
```
 | 
			
		||||
@@ -681,11 +681,11 @@ Alternatively, you can use a command to terminate/shutdown your WSL2 environment
 | 
			
		||||
 | 
			
		||||
On Windows with WSL 2, to resume developing you just need to open a new Git
 | 
			
		||||
BASH window. Then change into your `zulip` folder and verify the Python
 | 
			
		||||
environment was properly activated (you should see `(zulip-py3-venv)`). If the
 | 
			
		||||
`(zulip-py3-venv)` part is missing, run:
 | 
			
		||||
environment was properly activated (you should see `(zulip-server)`). If the
 | 
			
		||||
`(zulip-server)` part is missing, run:
 | 
			
		||||
 | 
			
		||||
```console
 | 
			
		||||
$ source /srv/zulip-py3-venv/bin/activate
 | 
			
		||||
$ source .venv/bin/activate
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
:::
 | 
			
		||||
@@ -765,7 +765,7 @@ When reporting your issue, please include the following information:
 | 
			
		||||
The output of `tools/diagnose` run inside the Vagrant guest is also
 | 
			
		||||
usually helpful.
 | 
			
		||||
 | 
			
		||||
#### Vagrant guest doesn't show (zulip-py3-venv) at start of prompt
 | 
			
		||||
#### Vagrant guest doesn't show (zulip-server) at start of prompt
 | 
			
		||||
 | 
			
		||||
This is caused by provisioning failing to complete successfully. You
 | 
			
		||||
can see the errors in `var/log/provision.log`; it should end with
 | 
			
		||||
@@ -1009,13 +1009,13 @@ Once you've provisioned successfully, you'll get output like this:
 | 
			
		||||
 | 
			
		||||
```console
 | 
			
		||||
Zulip development environment setup succeeded!
 | 
			
		||||
(zulip-py3-venv) vagrant@vagrant:/srv/zulip$
 | 
			
		||||
(zulip-server) vagrant@vagrant:/srv/zulip$
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
If the `(zulip-py3-venv)` part is missing, this is because your
 | 
			
		||||
If the `(zulip-server)` part is missing, this is because your
 | 
			
		||||
installation failed the first time before the Zulip virtualenv was
 | 
			
		||||
created. You can fix this by just closing the shell and running
 | 
			
		||||
`vagrant ssh` again, or using `source /srv/zulip-py3-venv/bin/activate`.
 | 
			
		||||
`vagrant ssh` again, or using `source .venv/bin/activate`.
 | 
			
		||||
 | 
			
		||||
Finally, if you encounter any issues that weren't caused by your
 | 
			
		||||
Internet connection, please report them! We try hard to keep Zulip
 | 
			
		||||
 
 | 
			
		||||
@@ -11,7 +11,7 @@ From the window where run-dev is running:
 | 
			
		||||
2016-05-04 18:33:13,330 INFO     127.0.0.1       GET     200  92ms /register/ (unauth@zulip via ?)
 | 
			
		||||
^C
 | 
			
		||||
KeyboardInterrupt
 | 
			
		||||
(zulip-py3-venv) vagrant@vagrant:/srv/zulip$ exit
 | 
			
		||||
(zulip-server) vagrant@vagrant:/srv/zulip$ exit
 | 
			
		||||
logout
 | 
			
		||||
Connection to 127.0.0.1 closed.
 | 
			
		||||
$
 | 
			
		||||
 
 | 
			
		||||
@@ -7,5 +7,5 @@ Zulip server:
 | 
			
		||||
$ vagrant up
 | 
			
		||||
$ vagrant ssh
 | 
			
		||||
 | 
			
		||||
(zulip-py3-venv) vagrant@vagrant:/srv/zulip$ ./tools/run-dev
 | 
			
		||||
(zulip-server) vagrant@vagrant:/srv/zulip$ ./tools/run-dev
 | 
			
		||||
```
 | 
			
		||||
 
 | 
			
		||||
@@ -14,14 +14,14 @@ Welcome to Ubuntu 22.04.3 LTS (GNU/Linux 5.15.0-92-generic x86_64)
 | 
			
		||||
Congrats, you're now inside the Zulip development environment!
 | 
			
		||||
 | 
			
		||||
You can confirm this by looking at the command prompt, which starts
 | 
			
		||||
with `(zulip-py3-venv)vagrant@`. If it just starts with `vagrant@`, your
 | 
			
		||||
with `(zulip-server) vagrant@`. If it just starts with `vagrant@`, your
 | 
			
		||||
provisioning failed and you should look at the
 | 
			
		||||
[troubleshooting section](/development/setup-recommended.md#troubleshooting-and-common-errors).
 | 
			
		||||
 | 
			
		||||
Next, start the Zulip server:
 | 
			
		||||
 | 
			
		||||
```console
 | 
			
		||||
(zulip-py3-venv) vagrant@vagrant:/srv/zulip$ ./tools/run-dev
 | 
			
		||||
(zulip-server) vagrant@vagrant:/srv/zulip$ ./tools/run-dev
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
You will see something like:
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user