###############################################################################
cyn.in is an open source Collaborative Knowledge Management Appliance that
enables teams to seamlessly work together on files, documents and content in
a secure central environment.
cyn.in v2 an open source appliance is distributed under the GPL v3 license
along with commercial support options.
cyn.in is a Cynapse Invention.
Copyright (C) 2008 Cynapse India Pvt. Ltd.
This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or any later version and observe
the Additional Terms applicable to this program and must display appropriate
legal notices. In accordance with Section 7(b) of the GNU General Public
License version 3, these Appropriate Legal Notices must retain the display of
the "Powered by cyn.in" AND "A Cynapse Invention" logos. You should have
received a copy of the detailed Additional Terms License with this program.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
Public License for more details.
You should have received a copy of the GNU General Public License along with
this program. If not, see <http://www.gnu.org/licenses/>.
You can contact Cynapse at support@cynapse.com with any problems with cyn.in.
For any queries regarding the licensing, please send your mails to
legal@cynapse.com
You can also contact Cynapse at:
802, Building No. 1,
Dheeraj Sagar, Malad(W)
Mumbai-400064, India
###############################################################################
WELCOME TO CYN.IN
-----------------------------------------
cyn.in is based upon the open source plone platform. While a complete
understanding of plone does help (a lot) it is not abosolutely essential to run
cyn.in.
REQUIREMENTS
------------
Operating System
=================
While it is possible to do a buildout successfully on the Microsoft Windows
operating system, it is not recommended - that way is fraught with difficulty and
strife.
Instead we recommend any linux distribution (we recommend Ubuntu 8.0.4) for doing
development on cyn.in as this provides the easiest and most rewarding path to developing
on cyn.in.
While we actively use Ubuntu, Debian and rPath linux to develop cyn.in there's no reason
that it should not work on any linux distribution that supports running python.
Required components
===================
The following components are required to build/run cyn.in successfully:
gcc - gnu c compiler
g++ - gnu c++ compiler
libc6-dev - c development headers
libssl-dev - ssl development headers
zlib1g-dev - zip processing librar
libjpeg62-dev - JPEG processing library
libreadline5-dev - Readline library
readline-common - common files for readline
libxml-dev - XML library development headers
wv - wv word data extraction tools
xpdf - pdf extraction tools
python2.4-dev - python 2.4 development headers
python-imaging - the PIL library
python-libxml2 - Python bindings for libxml
poppler - PDF extraction tools
These components can typically be installed on Ubuntu/Debian by running a
single command as follows (ALL ON ONE LINE):
sudo apt-get install gcc g++ libc6-dev libssl-dev zlib1g-dev libjpeg62-dev libreadline5-dev readline-common libxml-dev wv xpdf python2.4-dev python-imaging python-libxml2 poppler
Python
========
cyn.in REQUIRES to be run on python2.4 it will not work properly on earlier OR
later versions of python.
You can type python -V on your command prompt to see your current version of python.
BUILDOUT
---------------
The zip file containing the source of the cyn.in package is what is referred to
as a "buildout". This is a complete system for building and managing instances
of cyn.in.
More details on this are available here: http://pypi.python.org/pypi/zc.buildout
Extract the zip file to a suitable location and cd to it.
Edit user.cfg and change the effective-user setting to your username. For example
if you login with the user dhiraj then the line would read:
effective-user = dhiraj
Save the file and bootstrap your buildout by running:
python2.4 bootstrap.py
Then run this command:
mkdir ./parts/productsvns
Next you have to build the buildout - this will require a good Internet connection
because all required components will be downloaded automatically.
Run the following comand in the same directory:
./bin/buildout -Nvvvv -c user.cfg
This will display scrolling progress of buildout and will take a LOT of time, especially the
first time you do this.
RUNNING FOR THE FIRST TIME
---------------------------
When your buildout is complete, you can start the zope server by typing:
./bin/instance fg
This will start the zope server in foreground mode (so that you can easily
kill it by pressing Ctrl + C).
Read the scrolling output, if all goes well you will see something like
the following when the scrolling stops:
"2008-07-14 13:58:25 INFO Zope Ready to handle requests"
Congratulations, you've managed to get over the difficult parts. Now for the
easy stuff:
Open up your favorite browser (Everybody say together with me: Firefox 3!) :)
Navigate to http://localhost:8080 (if you use the same computer as desktop) or
substitute the localhost with the hostname (or even the IP address) of the
computer that zope/cyn.in is running on.
You should see the "Zope quick start screen". Cool, you can access your newly
built Zope server. Next, navigate to http://localhost:8080/manage .
This will give you an HTTP basic auth request. Use the following credentials
to get in:
username: admin
password: secret
You will see the standard Zope management interface. On the right you will see
a drop down list, next to a button labeled 'Add'.
From the list, scroll down and select "Plone Site", and you'll get the Add Plone
Site screen. Type in an ID for the plone site (I recommend cynin) and hit the
Add Plone Site button - do not change anything else.
This will take some time, if you're feeling geeky you can watch the scrolling
text in your fg command line window to see what's going on.
After some time your browser will arrive back at the zope management screen, with
one major difference, you'll see a new entry in the left tree view as well as
in the center list, cynin (Site).
Great, you've succeeded in adding a new plone site. Click on it.
Now, scroll down, and find the item called portal_quickinstaller (Allows to
install/uninstall products) and click on that.
You'll get a list of installable products, among these check the checkbox next
to the item labeled "Ubify Site Policy" and hit the Install button. Do NOT check
any other item.
Again, this will take some time and you can watch the scrolling progress in your
fg command line window. When it completes, the list will refresh where most of
the items will have moved down to the "Installed Products" section.
Great, you don't know it yet, but you've managed to get a working cyn.in
installation built out of source! :)
Let's get to proving that: In your browser, type up the following address:
http://localhost:8080/cynin
If you don't like doing as recommended and chose a different ID during Plone
Site creation, substitue your ID in place of cyin in the above URL, of course.
After some moments of tense waiting, the familiar cyn.in login screen should
greet you and you can get in by using the following standard credentials:
username: siteadmin
password: secret
NEXT STEPS AND CONTRIBUTIONS
----------------------------
If you're already familiar with plone and cyn.in you're going to want to build
new products that can be bundled along with the cyn.in package. So you want to
extend the existing products or add your own.
If you're not already familiar with plone I suggest the following recommended
reading:
The plone.org documentation section: http://plone.org/documentation
Read up on plone books: http://plone.org/documentation/books
The most recommended book is of course Martin Aspeli's famous "Professional
Plone Development" http://www.packtpub.com/Professional-Plone-web-applications-CMS/book
If you like the product and would like to contribute, or join us in the effort do
drop us a mail at devel@cynapse.com. Note this email is for developers and
contributors ONLY, do NOT put your support requests here.
For community support you can consider participating in the cyn.in community
site which is hosted by sourceforge at http://cynin.sourceforge.net
Commercial support is available from cynapse at http://support.cynapse.com
SUPPORT & LINKS
------------------------------------------
From installation, implementation to launch and even beyond, Cynapse is committed
to our customers on-going success. We provide access to skilled support engineers
coupled with flexible, easy-to-use resources for effective assistance.
Cynapse Customer Care Portal is available exclusively to customers. It is the
primary resource for information & technical support for deploying and
maintaining your cyn.in:
* Product Subscription Management
* Product order history
* Invoice & Profile management
* Support Ticket System
* Official Knowledge base
* Official Technical documentation
Please visit http://cyn.in for more information on cyn.in
Professional Support can be purchased from http://support.cynapse.com
The cyn.in v2 community site is hosted by sourceforge at http://cynin.sourceforge.net
Download Latest Version
CyninCE-313-i386-4.zip (308.3 MB)
