Browse Source

Update README.md

thehip 3 years ago
parent
commit
2305e982b6
1 changed files with 7 additions and 5 deletions
  1. 7 5
      README.md

+ 7 - 5
README.md

@ -1,16 +1,18 @@
1 1
# cpx
2 2
## Description
3
This repository is the home of the CPX project. It's like a private tracker, but made by me (and perhaps you!), so it's different and, I have to say, way better!<br />
4
  
5
This project has as goal to create a complete but simple website based on clean code. No dirty hacks at all, we promise!
3
This repository is the home of the CPX.CX project (often shortened as CPX). It's like a private tracker, but made by me (and perhaps you!), so it's different and, I have to say, way better!
4

													
5
This project has as goal to create a complete but simple torrent content management system based on clean code. No dirty hacks at all, we promise!
6

													
7
For setup instructions, have a look at the `Setup article` on the wiki.
6 8

													
7 9
## File Structure
8
CPX relies on a subdomain system. That's why the root of the project contains only directories and the main config file.<br />
10
CPX relies on a subdomain system. That's why the root of the project contains only directories and the main configuration file.<br />
9 11
 * <code>www</code> contains all dynamic files that are used by the user to access the data he wants, generally <code>.torrent</code> files.
10 12
 * <code>static</code> contains all static data (pictures, StyleSheets, ...) that the dynamic files rely on to ensure the website is displayed correctly. These files should be hosted on a basic webserver as PHP is not needed for these files.
11 13
 * <code>tracker</code> contains all the files related to the website's tracker. Basically, it's an implementation of the Bittorrent protocol so that torrent clients can meet each other.
12 14
<br />
13
The file <code>config.json</code> contains all basic data the tracker and the website need in order to run correctly. If you setup CPX on multiple machines, you must copy this on the tracker and website server's webroot parent directory
15
The file <code>config.json</code> contains all basic data the tracker and the website need in order to run correctly. If you setup CPX on multiple machines, you must copy this on the tracker and website servers' webroot parent directory for every server to share the same database.
14 16

													
15 17
## Disclaimer
16 18
This project should not be used for piracy. We do this only to discover how the system works!