You've already forked oncall
mirror of
https://github.com/linkedin/oncall.git
synced 2025-11-29 23:38:17 +02:00
docs: move docker setup into sphinx doc
This commit is contained in:
committed by
Joe Gillotti
parent
6a4b13a0ee
commit
fd14afd302
19
README.md
19
README.md
@@ -1,24 +1,5 @@
|
|||||||
Oncall [](https://gitter.im/irisoncall/Lobby)
|
Oncall [](https://gitter.im/irisoncall/Lobby)
|
||||||
======
|
======
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
Quickstart
|
|
||||||
-------------
|
|
||||||
### For users
|
|
||||||
To set up a local instance of Oncall, we recommend using Docker. Docker is available for download at https://www.docker.com/community-edition. We have a publicly available Docker image that can be set up using just two commands. After downloading docker, use
|
|
||||||
```docker run --name oncall-mysql -e MYSQL_ROOT_PASSWORD='1234' -d mysql```
|
|
||||||
to set up a MySQL database for Oncall to run with. Note that we set the MySQL root password to '1234'; you may wish to change this to something more secure.
|
|
||||||
|
|
||||||
After setting up the mysql container, we can set up an instance of Oncall running on http://localhost:8080 with the following:
|
|
||||||
```docker run -d --link oncall-mysql:mysql -p 8080:8080 -e DOCKER_DB_BOOTSTRAP=1 quay.io/iris/oncall```
|
|
||||||
Here, we link the mysql container created in the previous step with our Oncall container, allowing for easy MySQL access between the two containers. We also pass a DOCKER_DB_BOOTSTRAP environment variable indicating to our setup script that the database needs to be initialized. This will populate the database with a small amount of dummy data and set up the proper schema so we can get up and running.
|
|
||||||
|
|
||||||
Once these two steps are complete, you can visit localhost:8080 in your browser to check out Oncall. Try logging in as the user "jdoe", with any password (the Docker image defaults to debug authentication, which authenticates all credentials so long as the user exists in the DB). You can navigate to the "Browse Teams" page and check out "Test Team", which shows a calendar page where you can create and modify events.
|
|
||||||
|
|
||||||
|
|
||||||
### For developers
|
|
||||||
|
|
||||||
|
|
||||||
<img src="https://github.com/linkedin/oncall/raw/master/src/oncall/ui/static/images/oncall_logo_blue.png" width="100">
|
<img src="https://github.com/linkedin/oncall/raw/master/src/oncall/ui/static/images/oncall_logo_blue.png" width="100">
|
||||||
|
|
||||||
|
|||||||
35
docs/source/admin_guide.rst
Normal file
35
docs/source/admin_guide.rst
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
Admin guide
|
||||||
|
===========
|
||||||
|
|
||||||
|
Quickstart
|
||||||
|
----------
|
||||||
|
|
||||||
|
Test with Docker
|
||||||
|
````````````````
|
||||||
|
|
||||||
|
.. _Docker: https://www.docker.com/community-edition
|
||||||
|
|
||||||
|
A local test instance of Oncall can be setup with Docker_ in two commands:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
docker run -d --name oncall-mysql -e MYSQL_ROOT_PASSWORD='1234' mysql
|
||||||
|
docker run -d --link oncall-mysql:mysql -p 8080:8080 -e DOCKER_DB_BOOTSTRAP=1 quay.io/iris/oncall
|
||||||
|
|
||||||
|
.. NOTE::
|
||||||
|
We pass a **DOCKER_DB_BOOTSTRAP** environment variable to the Oncall container
|
||||||
|
indicating to our setup script that the database needs to be initialized. This
|
||||||
|
will populate the database with a small amount of dummy data and set up the
|
||||||
|
proper schema so we can get up and running.
|
||||||
|
|
||||||
|
The above commands set up an Oncall service and MySQL database. Note that we
|
||||||
|
set the MySQL root password to '1234'; you may wish to change this to something
|
||||||
|
more secure.
|
||||||
|
|
||||||
|
The test instance of Oncall can be accessed at http://localhost:8080. Try
|
||||||
|
logging in as the user "jdoe", with any password (the Docker image defaults to
|
||||||
|
disable authentication, which authenticates all credentials so long as the user
|
||||||
|
exists in the DB). You can navigate to the "Browse Teams" page and check out
|
||||||
|
"Test Team", which shows a calendar page where you can create and modify
|
||||||
|
events. See :ref:`user-guide` for more information on how to interact with the
|
||||||
|
UI.
|
||||||
@@ -23,6 +23,7 @@ time is notified of any issues.
|
|||||||
:caption: Table of contents
|
:caption: Table of contents
|
||||||
|
|
||||||
user_guide
|
user_guide
|
||||||
|
admin_guide
|
||||||
api
|
api
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,3 +1,5 @@
|
|||||||
|
.. _user-guide:
|
||||||
|
|
||||||
User guide
|
User guide
|
||||||
==========
|
==========
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user