Bitbucket is a code hosting site with unlimited public and private repositories. We're also free for small teams!

Close
-=================== OVERVIEW =====================-

Timekoin is an open source peer to peer based crypto-currency system. As such,
it relies on a combination of its own database and the database of other peers
to maintain one large public register. Because this public register can be seen
by anyone, the only way to make sure that one peer doesn't tamper with the
balance of another peer is to use key based encryption.

A peer has two keys. One to create transactions and another to unlock what is
inside the transaction. When a transaction is created, the key to unlock it is
also passed along with the transaction data. This allows anyone to look inside
the data to verify the contents, but prevents anyone from trying to masquerade
as that peer and create a transaction that is fake or changed. Any attempts to
alter the transaction data will fail because the key provided with it will no
longer work.

Timekoin uses 1,536 bit encryption (not a typo) to create the transactions and
SHA256 hashing both inside and outside the transaction to provide multiple
layers of anti-tampering protection wrapped in each other. Trying to tamper with
any of the 3 points results in the collapse of the entire transaction data.

The software requires these components before installing.

1. Web Server (Apache, IIS, etc.)
2. OpenSSL installed for the Web Server
3. PHP (v5 or higher) for the Web Server, including the CLI, mySQL, and OpenSSL
module
4. mySQL Database Server (v5 or higher, free community version works just fine)

-=================== QUICK INSTALL =====================-

If you are a tech guru, the software can be setup on any operating system that
supports the requirements above (Windows, Mac, Linux, Unix, etc.) If you already
have or know how to quickly install these, then you will be able to get up and
running very quickly.

All requirements above can use default settings, no special tweaking needed as
far as we know.

1.  Checklist Requirements:

	A. Verify that your web server has OpenSSL installed, PHP5 (with CLI,
mySQL, OpenSSL) modules installed, and that you have access to your mySQL server
to create new databases, set user permissions, etc. It's also important that you
have the ability to modify access rights on your web server as some of the
software will need execution privileges to function properly.


2. Database Setup:

	A. Start by creating a fresh database in mySQL, the default Collation of
should be fine, but if can set it for “utf8_general_ci” that is even better.
What you name the database is your business, but to be consistent we will name
our database “timekoin” in this document.

	B. Create a new user account in mySQL that will give you access to this
new database. The user account needs only very limited privileges to function,
so there is no need to give your new user account more permissions that it needs
to run the software. The privileges of SELECT, INSERT, UPDATE, DELETE, and DROP
is all the account needs. In this example, we created a new user account and
named it “tkuser” (how original). Be sure to set a good password for this
account.


3. File Setup on Web Server

	A. Now that the database is prepared, begin by creating a folder on your
web server. The folder name can be whatever you like, but we recommend
“timekoin” for these instructions. Copy all the files from the v1.X folder to
this new web folder. Make sure your directory structure stays intact so that the
“css” and “img” folders make it properly to their new home.

	B. File permissions are important as some files will need special
permissions to run properly (depends on if the setup is for Linux, Windows, Mac,
etc.) All files need at least “read” access, but this next list of files need
execute permissions to allow them to run with the web server permissions (no
admin or root needed). For those using Linux/Unix, apache permissions would be
an example.

--foundation.php (execute)
--generation.php (execute)
--genpeer.php (execute)
--main.php (execute)
--peerlist.php (execute)
--queueclerk.php (execute)
--transclerk.php (execute)
--treasurer.php (execute)
--watchdog.php (execute)

--status.php (needs read/write access only)

	C. All other files can remain at read access only. If you want to see if
PHP is executing your scripts properly, you can already visit the login page of
“index.php” Even though no database is setup yet, you will at least see the page
if it renders properly.

	D. Next, you need to modify the “configuration.php” file and fill out
the 4 fields. They include the MYSQL_IP which if your mySQL server runs
(localhost or some other IP address). Next is the MYSQL_USERNAME which you
created earlier, followed by MYSQL_PASSWORD which is self explanatory. Finally,
MYSQL_DATABASE which is the name of the database you created. Save this file
after modifications are complete.


4. Database New Install Information

	A. You will find in the “new_install_sql” folder one single file labeled
“timekoin.sql”. This contains a complete layout of a fresh new timekoin
database. You can simply import it directly into your new timekoin database
either via command line or from a web gui (like phpMyAdmin for example). This
will create all the tables and data you need to continue on to the next steps of
installation.


5. Key Creation for your Timekoin Server

	A. Located in the “util” folder is a single file labled “keys.php”. This
simple script will generate new random keys for your server and store them in
the new database. Simply copy this file to the same folder where “index.php” and
“main.php” reside. Execute the script in any web browser, it will use the
settings you saved in your configuration file earlier to access the database and
generate new random keys and store them. You will get a simple confirmation in
your web browser if this action succeeds or fails.

	B. If you are getting failures at this step, you need to check to make
sure your mySQL server settings are correct or that your web server and PHP both
have OpenSSL/mySQL modules working properly. If you get a success message, then
you are almost done getting your new server setup.

	C. DELETE the keys.php file after successful creation as it will not be
needed anymore and you don't want someone to wipe out your keys with new keys by
accident in their web browser.


6. Login to new Server

	A. At this point, you are nearly finished. All that remains is to login
and change some custom options before firing up your timekoin server for the
first time. Simple visit the “index.php” in your web browser and use this combo
to login with (as it's the default with a new install).
Username: timekoin
Password: 12345

	B. After login, click on the “Options” tab and change the username and
password so something better than the default for security reasons. The username
and password are stored as an encrypted hash, so there is no way to recover a
password or username if lost. Be sure to write down or save what you intend to
use for this.

	C. Next, click on the “System” tab. This section needs a bit of
technical info from you. Mainly, to be sure it can communicate with other
Timekoin peers, this information needs to be accurate. The section with “Server
Domain” is useful if you plan on running Timekoin directly from website with a
domain name. This will allow peers to find you via your website address instead
of your IP address. If you have no domain (for example, running the software on
a desktop PC or server with no domain attached), it's OK to leave this field
blank. 

The next important  field is “Timekoin Subfolder”. The default is “timekoin”
because usually peers would get to your server via http://mywebsite.com/timekoin
for a domain or http://192.168.1.1/timekoin for an IP address. If you are
running timekoin from a different folder (example
http://mywebsite.com/bobskoin/), then this field needs to updated accordingly.
This is how other peers will find you on the Internet, so if the folder is
inaccurate, your server will report an inaccurate path to the other peers and
thus peers will not be able to communicate back to your server.

	Finally, the “Server Port Number” field. This is simply the port number
that your timekoin server listens on. By default it is set for port 80 as that
is the standard for websites in general. But... if you have an ISP that blocks
certain ports (like 80), you can change this to communicate to peers that your
server is running on a different port number (like 8080 for example) and the
peers will be able to find you once again. This is only an information field and
does not change the port your web server is actually running on. You'll need to
consult your manual on the web server to do this, but it is usually trivial for
any web server package out there to listen on a different port or multiple ports
at the same time.


7. Start the Timekoin Server

	A. After everything is setup, it's time to start the server. In the
“System” tab is where you find the obvious buttons for start and stop. The
“Start Timekoin” button starts the main process that controls peer management
and transaction management. 

	The “Start Watchdog” button starts a monitoring process for all the
other software pieces. Mainly, it will make sure that nothing becomes “stuck”
due to some unknown software glitch or other unforeseen issue that would halt or
stop your server. It's role is much more important on “slower” systems than
modern (faster) systems. Slower meaning systems running at speeds less than 1
GHz or with less than 512MB of RAM. Slower systems can hang on large transaction
processing at odd times. Usually though, they will finish up, just much longer
than the other peers on the network and then have to play catch up on the
transaction history.

	The “Emergency Stop” button serves two roles. It will stop the Timekoin
process (but not the watchdog process) and then it will block all Internet
activity from peers. It serves as it says, an emergency stop of the system. You
may never have to use it, but it's good to know it's there for the future just
in case.




That concludes this quick install section. For more in depth information (walk
through installations) visit the website for more information about timekoin. 
There you will find more resources and forums to get the maximum enjoyment out
of your timekoin server software.

http://timekoin.org/


Cheers!
The Timekoin Community

Recent activity

Michele Bini

Commits by Michele Bini were pushed to rev22/timekoin

c24c8e5 - Make updates of status.php atomic even in networked filesystems, as long as file renames are atomic.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.