incubator-heraldry-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From quellho...@apache.org
Subject svn commit: r451503 - in /incubator/heraldry/idp/pip/trunk: INSTALL README config/api_keys.yml.example
Date Sat, 30 Sep 2006 00:27:29 GMT
Author: quellhorst
Date: Fri Sep 29 17:27:29 2006
New Revision: 451503

URL: http://svn.apache.org/viewvc?view=rev&rev=451503
Log:
update install to reference api_keys, change cr/lf to dos format in install and readme, remove
default api_key in example.yml.

Modified:
    incubator/heraldry/idp/pip/trunk/INSTALL
    incubator/heraldry/idp/pip/trunk/README
    incubator/heraldry/idp/pip/trunk/config/api_keys.yml.example

Modified: incubator/heraldry/idp/pip/trunk/INSTALL
URL: http://svn.apache.org/viewvc/incubator/heraldry/idp/pip/trunk/INSTALL?view=diff&rev=451503&r1=451502&r2=451503
==============================================================================
--- incubator/heraldry/idp/pip/trunk/INSTALL (original)
+++ incubator/heraldry/idp/pip/trunk/INSTALL Fri Sep 29 17:27:29 2006
@@ -1,66 +1,72 @@
-
-  PIP INSTALLATION OVERVIEW
-
-  Quick Start - Unix
-  ------------------
-
-  For more information on this project, visit 
-  http://incubator.apache.org/heraldry
-
-  To download the latest copy of PIP 
-     $ svn co https://svn.apache.org/repos/asf/incubator/heraldry/idp/pip/trunk pip
-
-  PIP depends on Ruby on Rails being installed and several gems. Ruby version 
-  1.8.4 is recommended which is available at 
-  http://www.ruby-lang.org/en/20020102.html. You will also need the gem utility
-  available at http://rubyforge.org/frs/?group_id=126
-
-  To install rails
-
-	 $ gem install rails -y
-	
-  Then install the other required gems
- 
-     $ gem install mongrel -y
-     $ gem install tzinfo
-     $ gem install ruby-openid -y
-
-  Rmagick depends on either the ImageMagick or GraphicsMagick image processing libraries.
-
-     $ gem install rmagick
-  
-  You will need 2 databases for development and testing.
-
-     $ mysqladmin create pip_dev -u root
-     $ mysqladmin create pip_test -u root
-
-  Now you will need to goto the local checkout of the pip code
-     $ cd pip
-     $ cp config/database.example.yml config/database.yml
-     $ cp config/settings.example.yml config/settings.yml
-	
-  Edit the config/database.yml file to match your local setup. You may need to
-  change the 'adapter: mysql' lines if you are using a database other than
-  MySQL and add your password to the 'password: ' lines. The mysqld.sock file
-  is sometimes not found, can can define it like 
-  'socket: /var/run/mysqld/mysqld.sock'. If you are unsure of the location try
-  running 'mysql_config' or 'locate mysqld.sock'.
-  
-  Edit the config/settings.yml to match your local setup. If you are only doing
-  local development then change 'yourappname.com' to 'localhost' in 
-  'app_host: yourappname.com'
-  
-  Create all the database tables
-
-     $ rake migrate
-
-  Configure your site settings
-  
-     $ vim config/settings.yml
-
-  Start the local server in development mode
-
-     $ sudo mongrel_rails start -p 80 -e development -S config/mongrel.conf
-
-  Navigate to http://localhost/ and if all went well, you will have a local copy 
-  of the pip running.
+
+  PIP INSTALLATION OVERVIEW
+
+  Quick Start - Unix
+  ------------------
+
+  For more information on this project, visit 
+  http://incubator.apache.org/heraldry
+
+  To download the latest copy of PIP 
+$ svn co https://svn.apache.org/repos/asf/incubator/heraldry/idp/pip/trunk pip
+
+  PIP depends on Ruby on Rails being installed and several gems. Ruby version 
+  1.8.4 is recommended which is available at 
+  http://www.ruby-lang.org/en/20020102.html. You will also need the gem utility
+  available at http://rubyforge.org/frs/?group_id=126
+
+  To install rails
+
+$ gem install rails -y
+	
+  Then install the other required gems
+ 
+$ gem install mongrel -y
+$ gem install tzinfo
+$ gem install ruby-openid -y
+
+  Rmagick depends on either the ImageMagick or GraphicsMagick image processing
+  libraries. Rmagick is used for the captcha on the create account page.
+
+$ gem install rmagick
+  
+  You will need 2 databases for development and testing.
+
+$ mysqladmin create pip_dev -u root
+$ mysqladmin create pip_test -u root
+
+  Now you will need to goto the local checkout of the pip code
+
+$ cd pip
+$ cp config/database.example.yml config/database.yml
+$ cp config/settings.example.yml config/settings.yml
+$ cp config/api_keys.yml.example config/api_keys.yml
+	
+  Edit the config/database.yml file to match your local setup. You may need to
+  change the 'adapter: mysql' lines if you are using a database other than
+  MySQL and add your password to the 'password: ' lines. The mysqld.sock file
+  is sometimes not found, can can define it like 
+  'socket: /var/run/mysqld/mysqld.sock'. If you are unsure of the location try
+  running 'mysql_config' or 'locate mysqld.sock'.
+  
+  Edit the config/settings.yml to match your local setup. If you are only doing
+  local development then change 'yourappname.com' to 'localhost' in 
+  'app_host: yourappname.com'
+
+  The config/api_keys.yml file is used to allow external sites to create 
+  accounts remotely.
+  
+  Create all the database tables
+
+$ rake migrate
+
+  Configure your site settings
+  
+$ vim config/settings.yml
+
+  Start the local server in development mode
+
+$ sudo mongrel_rails start -p 80 -e development -S config/mongrel.conf
+
+  Navigate to http://localhost/ and if all went well, you will have a local
+  copy of the pip running.

Modified: incubator/heraldry/idp/pip/trunk/README
URL: http://svn.apache.org/viewvc/incubator/heraldry/idp/pip/trunk/README?view=diff&rev=451503&r1=451502&r2=451503
==============================================================================
--- incubator/heraldry/idp/pip/trunk/README (original)
+++ incubator/heraldry/idp/pip/trunk/README Fri Sep 29 17:27:29 2006
@@ -1,45 +1,63 @@
-PERSONAL IDENTITY PROVIDER - PIP
-
-= How To Run
-View the INSTALL file for more details on installing and running PIP.
-
-= General Overview
-PIP is an open-source identity server that utilizes the OpenID 1.1 and Yadis 1.0 standards
to identify and distribute identity resources. 
-Users utilize PIP to manage digital identity information, authenticate themselves for consumer
sites, and authorize consumer sites for 
-access to their identity information. There are three main components to PIP: Yadis, OpenID,
and Profile Management. These components 
-are explained in more detail below.
-
-== Yadis
-Yadis 1.0 is service discovery system that allows consumer sites to know what services are
provided by PIP. It is provided as a service 
-directly by the mongrel server via lib/yadis_handler/lib/yadis_handler.rb. In a Yadis request,
the consumer site visits the identity url 
-provided by the user looking for Yadis headers that indicate where the Yadis document resides.
These headers are provided at 
-[pip_url]/user/[user_login]/yadis by lib/yadis_handler/lib/yadis_handler.rb and at [user_login].[pip_url]
by app/views/account/index.rhtml. 
-The document itself is provided at [pip_url]/user/[user_login]/yadis by yadis_handler.rb.
Though a Yadis document may point to many services, 
-the PIP Yadis document points only to the OpenID service provided by PIP.
-
-== OpenID
-OpenID 1.1 allows consumer sites to use identity urls, provided by PIP, to authenticate users
and gain access to identity data stored 
-within the PIP database. Though all OpenID transactions provide authentication of the user,
not all require or result in identity 
-information being exchanged. All OpenID functionality in PIP is provided through the ServerController

-in app/controllers/server_controller.rb. ServerController provides a single point of entry,
#index, with which consumer sites 
-can associate with the PIP and to which consumer sites can redirect their users to perform
authentication and authorization. 
-Consumer site association provides security against various attacks that can be performed
on the OpenID process. User authentication 
-and authorization are the process of the user logging in to PIP to authenticate that they
do own the identity url and the process by 
-which the user authorizes that the consumer site may have access to specific pieces of their
identity data. Metadata about information 
-shared and consumer sites that have been authorized is stored in the Profile and TrustRequest
models.
-
-== Profile Management
-PIP provides a single location at which a user may maintain his online identity. This service
is provided by PropertyTypesController in 
-conjunction with the PropertyType and Property models. Users have one Property, which contains
the identity information, per PropertyType, 
-which contains meta-information about the Property. Users have a default set of PropertyTypes
referred to as global property types that 
-they may not remove. In addition, they may create new PropertyTypes over which they have
full control. Currently, there are only eight 
-property types that are used in OpenID transactions. These are specified by User::OPEN_ID_MAPPINGS.
-
-== Further Reading
-For further insight into the behavior of the system, read the rDoc html files for the classes
mentioned above. The rDocs can be found in 
-doc/app/index.html. 
-
-= Requirements
-Mongrel Web Server - http://mongrel.rubyforge.org/
-JanRain ruby-openid and ruby-yadis gems - http://www.openidenabled.com/openid/libraries/ruby/download
-MySQL or other database server
+PERSONAL IDENTITY PROVIDER - PIP
+
+= How To Run
+View the INSTALL file for more details on installing and running PIP.
+
+= General Overview
+PIP is an open-source identity server that utilizes the OpenID 1.1 and Yadis 
+1.0 standards to identify and distribute identity resources.  Users utilize 
+PIP to manage digital identity information, authenticate themselves for 
+consumer sites, and authorize consumer sites for access to their identity 
+information. There are three main components to PIP: Yadis, OpenID, and 
+Profile Management. These components are explained in more detail below.
+
+== Yadis
+Yadis 1.0 is service discovery system that allows consumer sites to know what 
+services are provided by PIP. It is provided as a service directly by the 
+mongrel server via lib/yadis_handler/lib/yadis_handler.rb. In a Yadis request, 
+the consumer site visits the identity url provided by the user looking for 
+Yadis headers that indicate where the Yadis document resides. These headers are
+provided at [pip_url]/user/[user_login]/yadis by 
+lib/yadis_handler/lib/yadis_handler.rb and at [user_login].[pip_url] by 
+app/views/account/index.rhtml. The document itself is provided at 
+[pip_url]/user/[user_login]/yadis by yadis_handler.rb. Though a Yadis document 
+may point to many services, the PIP Yadis document points only to the OpenID 
+service provided by PIP.
+
+== OpenID
+OpenID 1.1 allows consumer sites to use identity urls, provided by PIP, to 
+authenticate users and gain access to identity data stored within the PIP 
+database. Though all OpenID transactions provide authentication of the user, 
+not all require or result in identity information being exchanged. All OpenID 
+functionality in PIP is provided through the ServerController in 
+app/controllers/server_controller.rb. ServerController provides a single point 
+of entry, #index, with which consumer sites can associate with the PIP and to 
+which consumer sites can redirect their users to perform authentication and 
+authorization. Consumer site association provides security against various 
+attacks that can be performed on the OpenID process. User authentication and 
+authorization are the process of the user logging in to PIP to authenticate 
+that they do own the identity url and the process by which the user authorizes
+that the consumer site may have access to specific pieces of their identity 
+data. Metadata about information shared and consumer sites that have been 
+authorized is stored in the Profile and TrustRequest models.
+
+== Profile Management
+PIP provides a single location at which a user may maintain his online 
+identity. This service is provided by PropertyTypesController in conjunction 
+with the PropertyType and Property models. Users have one Property, which 
+contains the identity information, per PropertyType, which contains 
+meta-information about the Property. Users have a default set of PropertyTypes 
+referred to as global property types that they may not remove. In addition, 
+they may create new PropertyTypes over which they have full control. 
+Currently, there are only eight property types that are used in OpenID 
+transactions. These are specified by User::OPEN_ID_MAPPINGS.
+
+== Further Reading
+For further insight into the behavior of the system, read the rDoc html files 
+for the classes mentioned above. The rDocs can be found in doc/app/index.html. 
+
+= Requirements
+Mongrel Web Server - http://mongrel.rubyforge.org/
+JanRain ruby-openid and ruby-yadis gems - 
+  http://www.openidenabled.com/openid/libraries/ruby/download
+MySQL or other database server

Modified: incubator/heraldry/idp/pip/trunk/config/api_keys.yml.example
URL: http://svn.apache.org/viewvc/incubator/heraldry/idp/pip/trunk/config/api_keys.yml.example?view=diff&rev=451503&r1=451502&r2=451503
==============================================================================
--- incubator/heraldry/idp/pip/trunk/config/api_keys.yml.example (original)
+++ incubator/heraldry/idp/pip/trunk/config/api_keys.yml.example Fri Sep 29 17:27:29 2006
@@ -2,4 +2,4 @@
 # Keys can be any length and combination of characters.
 # consumer: value
 
-a_company: AB332B934
+#a_company: AB332B934



Mime
View raw message