Skip to content

Commit

Permalink
Translate readme.md to English
Browse files Browse the repository at this point in the history
  • Loading branch information
maximthomas committed Oct 11, 2018
1 parent 36128cc commit 8aad024
Show file tree
Hide file tree
Showing 2 changed files with 90 additions and 30 deletions.
58 changes: 28 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,53 +10,51 @@
[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/OpenIdentityPlatform/OpenAM-.Net-Agent.svg)](https://github.com/OpenIdentityPlatform/OpenAM-.Net-Agent)


## Установка и настройка
Идентифицируйте папку ${site}, в которой размещены файлы вашего приложения, путем поиска файла ${site}/web.config
## Setup and Installation
Identify ${site} folder, where your application files are by finding ${site}/web.config file

### Установка файлов бинарной поставки:
* Скачайте [файл бинарной поставки](https://github.com/OpenIdentityPlatform/OpenAM-.Net-Agent/releases)
* Распакуйте содержимое в папку ${site}/bin
### Install binary distribution:
* Download [binary distribution file](https://github.com/OpenIdentityPlatform/OpenAM-.Net-Agent/releases)
* Extract archive contents to ${site}/bin

### Настройка записи журналов полиси агента:
* Создайте папку ${site}/App_Data/Logs
* Предоставьте право записи для пользователя IUSER_XXX в папку ${site}/App_Data/Logs
### Setup Policy Agent Logging:
* Create folder ${site}/App_Data/Logs
* Grant write access rights to ${site}/App_Data/Logs folder for account IUSER_XXX

### Настройка приложения:
Настройки полиси агента хранятся в файле ${site}/web.config в секции \<appSettings\>, добавьте следующие настройки:
### Application Setup:
Policy agent settings are in ${site}/web.config file. add following settings to \<appSettings\> section:
* \<add key="com.sun.identity.agents.config.naming.url" value="" /\>
* \<add key="com.sun.identity.agents.config.organization.name" value="/" /\>
* \<add key="com.sun.identity.agents.app.username" value="" /\>
* \<add key="com.iplanet.am.service.password" value="" /\>
* \<add key="com.sun.identity.agents.config.key" value="" /\> (опустите настройку, если password не криптован)
* \<add key="com.sun.identity.agents.config.local.log.path" value="${basedir}/App_Data/Logs"/\> (переопределите путь хранения журналов)
* \<add key="com.sun.identity.agents.config.key" value="" /\> (skip this setting, if password is not encrypted)
* \<add key="com.sun.identity.agents.config.local.log.path" value="${basedir}/App_Data/Logs"/\> (override log files path)

Значения настроек предоставляются администратором сервера OpenAM или могут быть найдены в файлe c:\iis7_agent\Identifier_${site_id}\config\OpenSSOAgentBootstrap.properties предыдущей установки
Settings values provided by OpenAM server administrator or could be found in c:\iis7_agent\Identifier_${site_id}\config\OpenSSOAgentBootstrap.properties file from previous installation.

### Включение полиси агента:
Включение полиси агента производится в файле ${site}/web.config в секции \<httpModules\> :
* Удалите предыдущую версию полиси агента: \<add name="iis7agent" /\>
* Добавьте новую версию полиси агента путем добавления строки: \<add name="OpenAM" type="ru.org.openam.iis.OpenAMHttpModule"\>
* Проверьте работу приложения и файлы журналов в ${site}/App_Data/Logs
### Enable Policy Agent
Policy Agent could be enabled in section \<httpModules\> in ${site}/web.config file:
* Remove previous policy agent version: \<add name="iis7agent" /\>
* Add new policy agent version, by adding entry: \<add name="OpenAM" type="ru.org.openam.iis.OpenAMHttpModule"\>
* Check application functionality and log files in ${site}/App_Data/Logs

ВАЖНО: добавление необходимо производить первой строчкой после тэга \<httpModules\> или после тега \<clear/\> внутри \<httpModules\> , если он существует.
IMPORTANT: new section must be first entry after \<httpModules\> tag or after \<clear/\> tag inside \<httpModules\>, if it exists

### Выключение полиси агента:
Включение полиси агента производится в файле ${site}/web.config в секции \<httpModules\> :
* Удалите строку: \<add name="OpenAM" type="ru.org.openam.iis.OpenAMHttpModule"\>
### Disable Policy Agent
Policy Agent could be disabled in \<httpModules\> section of ${site}/web.config file:
* Remove entry: \<add name="OpenAM" type="ru.org.openam.iis.OpenAMHttpModule"\>

### Примеры настройки
Пример настройки ${site}/web.config: https://github.com/OpenIdentityPlatform/OpenAM-.Net-Agent/blob/master/ru.org.openam.iis.site.sample/web.config
### Example Settings
Example settings ${site}/web.config: https://github.com/OpenIdentityPlatform/OpenAM-.Net-Agent/blob/master/ru.org.openam.iis.site.sample/web.config

### Возможные проблемы
## Possible Issues

#### System.Net.WebException: The underlying connection was closed: Could not establish trust relationship for the SSL/TLS secure channel
На сервере используется не доверенный сертификат. Добавьте сертификат сервера в список надежных или отключите строгую проверку сертификатов (не рекомендуется в продуктивной среде) настройкой:
The server uses non-trusted certificate. Add server certificate to trusted list or disable strict certificate check (not recommended in production):

\<add key="com.sun.identity.agents.config.trust.server.certs" value="true"/\>

#### System.Net.WebException: The underlying connection was closed: A connection that was expected to be kept alive was closed by the server. at System.Net.HttpWebRequest.GetResponse()
Сетевое оборудование некорректно обрабатывает поддержание открытых сетевых соединений, попробуйте запретить открытые соединения:
Networking equipment does not properly handle maintaining keepalive network connections, try to prohibit keepalive connections:

\<add key="org.openidentityplatform.agents.config.keepalive.disable" value="true"/\>


62 changes: 62 additions & 0 deletions README_ru.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# OpenAM .Net SDK and IIS policy agent
[![Latest release](https://img.shields.io/github/release/OpenIdentityPlatform/OpenAM-.Net-Agent.svg)](https://github.com/OpenIdentityPlatform/OpenAM-.Net-Agent/releases)
[![Build Status](https://travis-ci.org/OpenIdentityPlatform/OpenAM-.Net-Agent.svg)](https://travis-ci.org/OpenIdentityPlatform/OpenAM-.Net-Agent)
[![Build status](https://ci.appveyor.com/api/projects/status/a518k1mp0a0p95cn/branch/master?svg=true)](https://ci.appveyor.com/project/OpenIdentityPlatfom/openam-net-agent/branch/master)
[![Issues](https://img.shields.io/github/issues/OpenIdentityPlatform/OpenAM-.Net-Agent.svg)](https://github.com/OpenIdentityPlatform/OpenAM-.Net-Agent/issues)
[![Last commit](https://img.shields.io/github/last-commit/OpenIdentityPlatform/OpenAM-.Net-Agent.svg)](https://github.com/OpenIdentityPlatform/OpenAM-.Net-Agent/commits/master)
[![License](https://img.shields.io/badge/license-CDDL-blue.svg)](https://github.com/OpenIdentityPlatform/OpenAM-.Net-Agent/blob/master/LICENSE.md)
[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](http://gitter.im/OpenIdentityPlatform/OpenAM)
[![GitHub top language](https://img.shields.io/github/languages/top/OpenIdentityPlatform/OpenAM-.Net-Agent.svg)](https://github.com/OpenIdentityPlatform/OpenAM-.Net-Agent)
[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/OpenIdentityPlatform/OpenAM-.Net-Agent.svg)](https://github.com/OpenIdentityPlatform/OpenAM-.Net-Agent)


## Установка и настройка
Идентифицируйте папку ${site}, в которой размещены файлы вашего приложения, путем поиска файла ${site}/web.config

### Установка файлов бинарной поставки:
* Скачайте [файл бинарной поставки](https://github.com/OpenIdentityPlatform/OpenAM-.Net-Agent/releases)
* Распакуйте содержимое в папку ${site}/bin

### Настройка записи журналов полиси агента:
* Создайте папку ${site}/App_Data/Logs
* Предоставьте право записи для пользователя IUSER_XXX в папку ${site}/App_Data/Logs

### Настройка приложения:
Настройки полиси агента хранятся в файле ${site}/web.config в секции \<appSettings\>, добавьте следующие настройки:
* \<add key="com.sun.identity.agents.config.naming.url" value="" /\>
* \<add key="com.sun.identity.agents.config.organization.name" value="/" /\>
* \<add key="com.sun.identity.agents.app.username" value="" /\>
* \<add key="com.iplanet.am.service.password" value="" /\>
* \<add key="com.sun.identity.agents.config.key" value="" /\> (опустите настройку, если password не криптован)
* \<add key="com.sun.identity.agents.config.local.log.path" value="${basedir}/App_Data/Logs"/\> (переопределите путь хранения журналов)

Значения настроек предоставляются администратором сервера OpenAM или могут быть найдены в файлe c:\iis7_agent\Identifier_${site_id}\config\OpenSSOAgentBootstrap.properties предыдущей установки

### Включение полиси агента:
Включение полиси агента производится в файле ${site}/web.config в секции \<httpModules\> :
* Удалите предыдущую версию полиси агента: \<add name="iis7agent" /\>
* Добавьте новую версию полиси агента путем добавления строки: \<add name="OpenAM" type="ru.org.openam.iis.OpenAMHttpModule"\>
* Проверьте работу приложения и файлы журналов в ${site}/App_Data/Logs

ВАЖНО: добавление необходимо производить первой строчкой после тэга \<httpModules\> или после тега \<clear/\> внутри \<httpModules\> , если он существует.

### Выключение полиси агента:
Включение полиси агента производится в файле ${site}/web.config в секции \<httpModules\> :
* Удалите строку: \<add name="OpenAM" type="ru.org.openam.iis.OpenAMHttpModule"\>

### Примеры настройки
Пример настройки ${site}/web.config: https://github.com/OpenIdentityPlatform/OpenAM-.Net-Agent/blob/master/ru.org.openam.iis.site.sample/web.config

### Возможные проблемы

#### System.Net.WebException: The underlying connection was closed: Could not establish trust relationship for the SSL/TLS secure channel
На сервере используется не доверенный сертификат. Добавьте сертификат сервера в список надежных или отключите строгую проверку сертификатов (не рекомендуется в продуктивной среде) настройкой:

\<add key="com.sun.identity.agents.config.trust.server.certs" value="true"/\>

#### System.Net.WebException: The underlying connection was closed: A connection that was expected to be kept alive was closed by the server. at System.Net.HttpWebRequest.GetResponse()
Сетевое оборудование некорректно обрабатывает поддержание открытых сетевых соединений, попробуйте запретить открытые соединения:

\<add key="org.openidentityplatform.agents.config.keepalive.disable" value="true"/\>


0 comments on commit 8aad024

Please sign in to comment.