Skip to content

LLM-Driven Extraction of Unstructured Data — Built for API Deployments & ETL Pipeline Workflows

docs: Include authentication info for OSS (#129)

Chandrasekharan M11cb702cca2e
diff --git a/README.md b/README.md
index c1389f072..7161526f8 100644
--- a/README.md
+++ b/README.md
@@ -47,6 +47,11 @@ Now visit [http://frontend.unstract.localhost](http://frontend.unstract.localhos
That's all. Enjoy!
+## Authentication
+
+The default username is `unstract` and the default password is `unstract`.
+More details on configuring this can be found in [backend's README.md](/backend/README.md#authentication)
+
## Configuring a Text Extractor
Unstract predominantly works with PDF documents and it requires a `Text Extractor` to be configured in the application which helps retrieve text from the documents. Currently supported text extractors include
diff --git a/backend/README.md b/backend/README.md
index db7224690..1185bf14a 100644
--- a/backend/README.md
+++ b/backend/README.md
@@ -36,21 +36,23 @@ python manage.py runserver localhost:8000
- Server will start and run at port 8000. (<http://localhost:8000>)
-## Setting Username and Password
+## Authentication
The default username is `unstract` and the default password is `unstract`.
-To customize your username or password:
-1. Navigate to the `.env` file located at `backend`.
-2. Update the values for `DEFAULT_AUTH_USERNAME` and `DEFAULT_AUTH_PASSWORD` with strong, unique credentials of your choosing.
-3. Save the `.env` file and restart the server to apply changes.
+To customize the username or password:
-> **NOTE**: The username `admin` is reserved for Django admin, hence cannot be used.
+1. Navigate to `/backend/.env` created from [/backend/sample.env](/backend/sample.env)
+1. Update the values for `DEFAULT_AUTH_USERNAME` and `DEFAULT_AUTH_PASSWORD` with strong, unique credentials of your choosing
+1. Save the `/backend/.env` file and restart the server to apply changes
+
+> **NOTE**: The username `admin` is reserved for Django admin, hence cannot be used
To update the username or password after it's been set:
-1. Modify the username and password in `.env`.
-2. Restart server to apply updates.
-3. Login with the new credentials.
+
+1. Modify the username and password in the same `/backend/.env`
+1. Restart server to apply updates
+1. Login with the new credentials
## Asynchronous execution/pipeline execution