Skip to content

Commit

Permalink
Super user doc (#75)
Browse files Browse the repository at this point in the history
* Add super user doc

* Update references

* Add blank line at the end of file
  • Loading branch information
ketankartoza authored Aug 14, 2024
1 parent 00dd116 commit 2623404
Show file tree
Hide file tree
Showing 8 changed files with 66 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/mkdocs-base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ nav:
- administrator/index.md
- Guide:
- administrator/guide/index.md
- Access Admin Panle: administrator/guide/access-admin-panel.md
- Manual:
- administrator/manual/index.md
- Django Administration: administrator/manual/django-admin.md
Expand Down
60 changes: 60 additions & 0 deletions docs/src/administrator/guide/access-admin-panel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Accessing the Django Admin Panel

To access the Django admin panel, follow these steps:

1. **Access the Bash of the Django Container**
First, you need to access the bash of the container running Django.

**List Running Containers:**

Use the following command to view the running containers:

```docker ps```

This command displays a list of running containers. Locate and copy the name of the container running the Django image.

![Running containers](./img/access-admin-panel-1.png)

2. **Access the Container's Bash:**

Run the following command to open a bash session in the container:

```docker exec -it <Container Name> bash```

Replace <'Container Name'> with the name of your Django container. For example:

```docker exec -it tomorrownow_gap-dev-1 bash```

![Bash](./img/access-admin-panel-2.png)

3. **Create a Django Superuser**

Within the container’s bash session, create a Django superuser by running:

```python manage.py createsuperuser```

You will be prompted to enter the following details:

- Username
- Email address
- Password

![SuperUser](./img/access-admin-panel-3.png)

4. **Log in to the Django Admin Panel:**

Once the superuser is created, you can access the Django admin panel through the web browser. Open your web browser and navigate to the following URL:

http://yourhost/admin/

For Example:

http://localhost:8000/admin/

Enter your username and password that you set up earlier, then click the 1️⃣ `Login` button, to access the admin panel.

![Login page](./img/access-admin-panel-4.png)

After login you will see the admin panel.

![admin panel](./img/access-admin-panel-5.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 5 additions & 3 deletions docs/src/administrator/guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ license: This program is free software; you can redistribute it and/or modify it

---

# Administrator guide
<!-- Narrative Instructions on how admin users will use the product/platform -->
<!-- Replace all of the titles with relevant titles -->
# Administrator Guide

Welcome to the administrator guide. In this section of the documentation, we aim to show administrators common workflows for managing the platform effectively. Here is a brief overview of the content provided here:

* **[Accessing the Administration Panel:](./access-admin-panel.md)** This section contains a quick description on how administrators can access the administration site of the platform.

0 comments on commit 2623404

Please sign in to comment.