Skip to content

Commit 098a902

Browse files
docs: Update start_crm.md to clarify running CRM on built-in server and specific IP
1 parent 9db0de7 commit 098a902

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

docs/site/start_crm.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,29 @@
1-
## Run CRM on the built-in server
1+
# Run CRM using the built-in server
22

33
!!! Note
44
Don't use this server in anything resembling a production environment (with access to the CRM from the Internet).
55
It is intended only for use on a personal computer or in intranet - a private local network (for example, during development).
66

77
The built-in server can only be used when `DEBUG = True` (the default setting).
88

9+
## Run CRM on localhost
10+
911
``` cmd
1012
python manage.py runserver
1113
```
1214

13-
In this case, [Django CRM](https://docs.djangoproject.com/en/dev/ref/contrib/admin/){target="_blank"} will be available on your computer on the IP address `http://127.0.0.1:8000` (localhost with port 8000).
14-
Open the web page at this address in your browser.
15-
If you need to provide access to CRM from an intranet (local network), specify the IP address of your network card and port
15+
In this case, CRM will be available on your computer on the IP address `http://127.0.0.1:8000` (localhost with port 8000).
16+
But if you open the web page at this address in your browser, you will see an error page.
17+
The login address for CRM is listed below, in the ["Access to CRM and admin sites"](#access-to-crm-and-admin-sites) section.
18+
19+
You may encounter log messages such as:
20+
`Another instance is already running, quitting.`
21+
This behavior is expected and requires no intervention.
22+
Django CRM operates as a self-hosted web application where the server may spawn multiple worker processes to handle concurrent tasks. However, certain internal services within the CRM are designed to run as a single instance to maintain data integrity or avoid conflicts. To enforce this, duplicate instances of these services are automatically detected and terminated during startup.
23+
24+
## Run CRM on a specific IP address and port
25+
26+
If you need to provide access to CRM from an intranet (local network), specify the IP address of your network card and port.
1627

1728
!!! Important
1829
But first, [specify the CRM website domain](#specify-crm-site-domain).
@@ -23,12 +34,6 @@ For example:
2334
python manage.py runserver 1.2.3.4:8000
2435
```
2536

26-
You may encounter log messages such as:
27-
`Another instance is already running, quitting.`
28-
This behavior is expected and requires no intervention.
29-
Django CRM operates as a web application where the server may spawn multiple worker processes to handle concurrent tasks. However, certain internal services within the CRM are designed to run as a single instance to maintain data integrity or avoid conflicts. To enforce this, duplicate instances of these services are automatically detected and terminated during startup.
30-
31-
3237
## Access to CRM and admin sites
3338

3439
Now you have two websites.
@@ -47,7 +52,7 @@ and Admin site for administrators (superusers):
4752
can be changed in the file `webcrm/settings.py`
4853

4954
!!! Note
50-
Do not attempt to access the bare `<your CRM host>` address ( `http://127.0.0.1:8000/` ).
55+
Do not attempt to access the bare `<your CRM host>` address (`http://127.0.0.1:8000/`).
5156
This address is not supported.
5257
To protect CRM with a site server (e.g. [Apache](https://httpd.apache.org/){target="_blank"}), a redirect to a fake login page can be placed on this address.
5358

@@ -71,4 +76,3 @@ Many buttons and icons on CRM pages have tooltips that appear when you hover ove
7176

7277
Many pages have an icon <span style="vertical-align: baseline"><img src="../icons/question-mark.svg" alt="Question-mark icon" width="25" height="25"></span> in the upper right corner.
7378
This is a link to a help page.
74-

0 commit comments

Comments
 (0)