globuzma/canaille-globuzma
1
0
Fork 0
forked from Github-Mirrors/canaille
Code Pull requests Activity

Fixed readme links

Browse source
This commit is contained in:
Éloi Rivard 2020-11-12 09:30:39 +01:00
parent 6561074f4c
commit 2e3fbee0f6
3 changed files with 18 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
CONTRIBUTING.rst
View file

@ -16,12 +16,19 @@ We use `black` to format our code. Please apply `black` on your patches before s
Development environment Development environment
----------------------- -----------------------
To try a development environment, you can run the docker image and then open https://127.0.0.1:5000 to access the canaille server.
Two dummy clients are available at https://127.0.0.1:5001 and https://127.0.0.1:5002
You can then connect with user *admin* and password *admin* to access an admin account, or user *user* and password *user* for a regular one.
.. code-block:: console .. code-block:: console
cd demo cd demo
./run.sh ./run.sh
# or 'docker-compose up' if you prefer docker
Then you have access to:
- A canaille server at http://127.0.0.1:5000
- A dummy client at http://127.0.0.1:5001
- Another dummy client at http://127.0.0.1:5002
The canaille server has some default users:
- A regular user which login and password are **user**;
- A moderator user which login and password are **moderator**;
- An admin user which admin and password are **admin**.

6
README.md
View file

@ -24,6 +24,6 @@ It aims to be very light, simple to install and simple to maintain. Its main fea
⚠ Canaille is under heavy development and may not fit a production environment yet. ⚠ ⚠ Canaille is under heavy development and may not fit a production environment yet. ⚠
- Please have a look on our [documentation](https://canaille.readthedocs.io>); - Please have a look on our [documentation](https://canaille.readthedocs.io);
- To **install** canaille, just follow the [installation guide](https://canaille.readthedocs.io/install.html); - To **install** canaille, just follow the [installation guide](https://canaille.readthedocs.io/en/latest/install.html);
- To **contribute** canaille, please read the [contribution guide](https://canaille.readthedocs.io/contributing.html>). - To **contribute** canaille, please read the [contribution guide](https://canaille.readthedocs.io/en/latest/contributing.html).

6
demo/README.md
View file

@ -11,6 +11,6 @@ Then you have access to:
The canaille server has some default users: The canaille server has some default users:
- A regular user which login and password are *user*; - A regular user which login and password are **user**;
- A moderator user which login and password are *moderator*; - A moderator user which login and password are **moderator**;
- An admin user which admin and password are *admin*. - An admin user which admin and password are **admin**.