First Server Run

Required steps for your first run of Ghostwriter

Creating Users

The first time you use Ghostwriter, a super user must be created to access the admin panel and create new users.

This is the administrator of all of Django, so set a strong password and document it in a password vault somewhere.

Create a Superuser

To create a superuser, run:

docker-compose -f local.yml run --rm django python manage.py createsuperuser

Visit http://SERVER_IP:8000/admin to view the admin panel and login using the superuser.

The defaults for the local deployment have the server listening on localhost, 127.0.0.01, and 0.0.0.0 on Django's default development, 8000.

Creating New Users

You may create users using the admin panel or ask users to sign-up using /accounts/signup. Filling out a complete profile is recommended. Ghostwriter will make use of full names for displaying user actions and email addresses can be helpful for custom tasks that send email notifications.

Django usernames are weirdly case sensitive, so all lowercase is recommended to avoid confusion later.

Signups are disabled by default as it is assume most users will not want it to be open. Signups are managed by the DJANGO_ACCOUNT_ALLOW_REGISTRATION in your .envs configuration. Set it to True in your .django file to re-enable it.

Password Changes

Once a user has been created, the username and password can be handed off to the intended user. That person may then login and click their avatar icon in the upper-right corner to change their password and upload a custom avatar (if they so desire).

If users are signing-up, then hopefully they know their password. Password resets can be requested using their email addresses.

Next Steps

Use Ghostwriter for some time and see if everything is working properly. If you intend to make modifications to the codebase now is the time to do that.