Zulip Operator Commands - Revision history

Fincato at 11:48, 17 June 2022

2022-06-17T11:48:00Z

← Older revision		Revision as of 13:48, 17 June 2022
Line 9:		Line 9:

	* ssh to server as zulip		* ssh to server as zulip
			* Then run: <code>/home/zulip/deployments/current/scripts/restart-server</code>
	Then run:		* You can login as another user to the VPS, and impersonate the zulip user by doing:
			** <code>su zulip -c /home/zulip/deployments/current/scripts/restart-server</code>
	<code>		** This command will first prompt you for the zulip user password.
	/home/zulip/deployments/current/scripts/restart-server
	</code>

	You can login as another user to the VPS, and impersonate the zulip user by doing:

	<code>
	su zulip -c /home/zulip/deployments/current/scripts/restart-server
	</code>

	This command will first prompt you for the zulip user password.

	== Use Manage CLI ==		== Use Manage CLI ==

Fincato at 11:46, 17 June 2022

2022-06-17T11:46:05Z

← Older revision		Revision as of 13:46, 17 June 2022
Line 8:		Line 8:
	In the necessity of restarting Zulip:		In the necessity of restarting Zulip:

	- ssh to server as zulip		* ssh to server as zulip

	Then run:		Then run:

Fincato at 11:45, 17 June 2022

2022-06-17T11:45:54Z

← Older revision		Revision as of 13:45, 17 June 2022
Line 3:		Line 3:
	}}		}}
	[[Category:Maintenance]]		[[Category:Maintenance]]

			== Restart Zulip ==

			In the necessity of restarting Zulip:

			- ssh to server as zulip

			Then run:

			<code>
			/home/zulip/deployments/current/scripts/restart-server
			</code>

			You can login as another user to the VPS, and impersonate the zulip user by doing:

			<code>
			su zulip -c /home/zulip/deployments/current/scripts/restart-server
			</code>

			This command will first prompt you for the zulip user password.

			== Use Manage CLI ==

	Zulip has extensive [https://zulip.com/api/ user-facing APIs], as well as a CLI called [https://zulip.readthedocs.io/en/stable/production/management-commands.html Management commands] to run common actions when working with the Zulip system.		Zulip has extensive [https://zulip.com/api/ user-facing APIs], as well as a CLI called [https://zulip.readthedocs.io/en/stable/production/management-commands.html Management commands] to run common actions when working with the Zulip system.

	== Instruction ==		=== Instruction ===

	* ssh with the zulip account to the server		* ssh with the zulip account to the server
Line 14:		Line 36:
	As part of each command invocation, a "realm" ID shoud be set: eg, a number associated with the Zulip instance we want to work with.		As part of each command invocation, a "realm" ID shoud be set: eg, a number associated with the Zulip instance we want to work with.

	=== To list all realms ===		==== To list all realms ====

	Do:		Do:
Line 24:		Line 46:
	Then take note of the number (realm ID) associated with the URL at which the Zulip instance runs on.		Then take note of the number (realm ID) associated with the URL at which the Zulip instance runs on.

	== To create a new user ==		=== To create a new user ===

	Do:		Do:

Fincato: Created page with "{{Article |MainNavigation=No }} Category:Maintenance Zulip has extensive [https://zulip.com/api/ user-facing APIs], as well as a CLI called [https://zulip.readthedocs.i..."

2022-05-23T14:41:35Z

Created page with "{{Article |MainNavigation=No }} Category:Maintenance Zulip has extensive [https://zulip.com/api/ user-facing APIs], as well as a CLI called [https://zulip.readthedocs.i..."

New page

{{Article
|MainNavigation=No
}}
[[Category:Maintenance]]

Zulip has extensive [https://zulip.com/api/ user-facing APIs], as well as a CLI called [https://zulip.readthedocs.io/en/stable/production/management-commands.html Management commands] to run common actions when working with the Zulip system.

== Instruction ==

* ssh with the zulip account to the server
* cd into deployments/current (full path it's usually <code>/home/zulip/deployments/current</code>)
* run <code>./manage.py</code> to print a list of all available commands

As part of each command invocation, a "realm" ID shoud be set: eg, a number associated with the Zulip instance we want to work with.

=== To list all realms ===

Do:

<pre>
./manage.py list_realms
</pre>

Then take note of the number (realm ID) associated with the URL at which the Zulip instance runs on.

== To create a new user ==

Do:

<pre>
./manage.py create_user '<email> '<user name>' -r <realm ID> --this-user-has-accepted-the-tos --password='<password>'
</pre>

After this an email should be sent to the set email, and the user already created in the Zulip system. This might be useful when having problems with creating a new user invitation purely via email using the Zulip GUI commands (sometimes confirmation emails — after the user signed up to Zulip via the shared URL invitation — don't arrive to the user's desired email).