Skip to content

Commit

Permalink
Remove outdated project name from description
Browse files Browse the repository at this point in the history
  • Loading branch information
c-w committed Jun 24, 2018
1 parent 8e24be4 commit 1d6dbbd
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
19 changes: 10 additions & 9 deletions README.rst
Expand Up @@ -13,9 +13,10 @@ Opwen cloudserver
What's this?
------------

This repository contains the source code for the Opwen cloud server. Its purpose
is to connect the `application <https://github.com/ascoderu/opwen-webapp>`_
running on the Opwen Lokole devices to the rest of the world.
This repository contains the source code for the Lokole cloud server. Its
purpose is to connect the `application <https://github.com/ascoderu/opwen-webapp>`_
running on the Lokole devices to the rest of the world. Lokole is a project
by the Canadian-Congolese non-profit `Ascoderu <https://ascoderu.ca>`_.

The server has two main responsibilities:

Expand All @@ -35,10 +36,10 @@ System overview
Data exchange format
--------------------

In order to communicate between the Opwen cloud server and the Opwen
web-application (aka Lokole), a protocol based on gzipped jsonl files uploaded
to Azure Blob Storage is used. The files contains a JSON object per line.
Each JSON object describes an email, using the following schema:
In order to communicate between the Lokole cloud server and the Lokole email
application, a protocol based on gzipped jsonl files uploaded to Azure Blob
Storage is used. The files contains a JSON object per line. Each JSON object
describes an email, using the following schema:

.. sourcecode :: json
Expand Down Expand Up @@ -98,7 +99,7 @@ to initialize the required cloud resources.

.. sourcecode :: sh
docker build -t opwenserversetup -f docker/setup/Dockerfile .
docker build -t setup -f docker/setup/Dockerfile .
docker run \
-e SP_APPID={appId field of your service principal} \
Expand All @@ -109,7 +110,7 @@ to initialize the required cloud resources.
-e RESOURCE_GROUP_NAME={the name of the resource group to create or reuse} \
-e SENDGRID_KEY={the sendgrid key you created earlier} \
-v ${PWD}/secrets:/secrets \
opwenserversetup
setup
The secrets to access the Azure resources created by the setup script will be
stored in files in the :code:`secrets` directory. Other parts of the
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Expand Up @@ -29,7 +29,7 @@
packages=packages,
url='https://github.com/ascoderu/opwen-cloudserver',
license='Apache Software License',
description='Email server for the Opwen project',
description='Email server for the Lokole project: https://ascoderu.ca',
long_description=long_description,
scripts=scripts,
include_package_data=True,
Expand Down

0 comments on commit 1d6dbbd

Please sign in to comment.