Source

helloweb / INSTALL

Full commit
## Installation instructions in English.

### 1. Download the source code

You can get the latest version from [Mercurial repository](http://freehg.org/u/sergey/helloweb/):

    $ hg clone http://freehg.org/u/sergey/helloweb/

### 2. Register at Google AppEngine

Registered users now can install up to 10 applications free of charge. You have to create a new application.
Download also AppEngine SDK. It allows for previewing the site locally. Also it manages upload to AppEngine.

### 3. Configure installation

In `app.yaml` in `application:` field indicate the name of your application at AppEngine.  If your application is named `example`, then in `app.yaml` you have to write this:

    application: example

Change the template as you like. Feel free to do any other changes, but please publish the modified code, as it is required by the terms of GNU Affero GPL.

### 4. Test locally

Run site with `dev_appserver.py` from AppEgnine SDK:

    $ dev_appserver.py path-to-helloweb

The site will be visible as http://localhost:8080/

### 5. Upload to AppEngine

`appcfg.py` utility from AppEngine SDK does this:

    $ appcfg.py --email=your_email@gmail.com update path-to-helloweb

Done! Now you can start using your new dynamic site on appspot.com.

You can find additional information about `dev_appserver.py`, `appcfg.py` and `app.yaml` AppEngine SDK documentation.

----

## Инструкция по установке по-русски ниже.

### 1. Скачайте исходный код программы

Последнюю версию программы можно взять из [репозитория Mercurial](http://freehg.org/u/sergey/helloweb/) на freehg.org:

    $ hg clone http://freehg.org/u/sergey/helloweb/

### 2. Зарегистрируйтесь на Google AppEngine

В данный момент зарегистрированные пользователи AppEngine получают право разместить на AppEngine до 10 приложений бесплатно. Создайте такое приложение. Его имя нужно будет внести в настройки программы.

Скачайте AppEngine SDK. Он позволит вам испытать сайт на рабочем компьютере, а затем и загрузить на AppEngine.

### 3. Настройте код под свои нужды

В файле `app.yaml` в поле `application:` укажите имя вашего приложения на AppEngine.  Пусть, к примеру, ваше приложение называется `example`, тогда в `app.yaml` должна быть такая строчка.

    application: example

Настройте шаблон. Вы можете делать и другие изменения, но в этом случае не забудьте опубликовать изменённый код программы, как того требуют условия лицензии GNU AGPL.

### 4. Проверьте работу сайта на локальном компьютере

Если Google AppEngine SDK уже установлен, то запустить сайт локально можно с помощью `dev_appserver.py`:

    $ dev_appserver.py путь-к-каталогу-helloweb

Сайт будет доступен для тестирования по адресу http://localhost:8080/

### 5. Загрузите сайт на AppEngine

Эту задачу выполнит утилита `appcfg.py`:

    $ appcfg.py --email=ваш_адрес@gmail.com update путь-к-каталогу-helloweb

Готово! Теперь вы можете использовать новый динамический сайт на  appspot.com и наполнять его содержимым.

Дополнительная информация по использованию `dev_appserver.py` и `appcfg.py` и по формату файла `app.yaml` имеется в документации к AppEngine SDK.