traxxx/README.md

108 lines
3.3 KiB
Markdown

# Traxxx
**NSFW** - The latest releases from your favorite porn studios in one place.
## Install & run
Use [nvm](https://github.com/creationix/nvm) to install a recent version of NodeJS. Download and unpack or clone this repository, and run the following in the root directory:
`npm install`
### Set up database
Install PostgreSQL, make sure password authentication is enabled (scram-sha-256) and create a database with a privileged user. For optimal search engine performance, copy `traxxx.stop` to your PostgresQL text search directory, usually `/usr/share/postgresql/tsearch_data/ or `/usr/local/share/postgresql/tsearch_data/`.
### Configuration
Do not modify `config/default.js`, but instead create a copy at `config/local.js` containing the properties you wish to change. If you have set `NODE_ENV`, copy `assets/js/config/default.js` to `assets/js/config/[environment].js`. After setting up PostgreSQL and configuring the details, run the following commands to create and populate the tables, and build the project:
`npm run migrate`
`npm run seed`
You can also use `npm run flush` to run both steps at once, and wipe the database completely later.
### Building
To build traxxx, run the following command:
`npm run build`
To generate the thumbnails for logos and tag photos, run:
`npm run logos-thumbs`
`npm run tags-thumbs`
### Run
`./traxxx --option value` or `npm start -- --option value`
* `--server`: Run the web server
* `--all`: Fetch updates from the channels and networks in the configuration file.
* `--channel [slug] [slug]`: Fetch updates from specific channels. The slug is the channel's name in lowercase and without cases or special characters. For example, Teens Like It Big is teenslikeitbig.
* `--network [slug] [slug]`: Fetch updates from all sites of a specific network. The network slug is composed similarly to the channel slug.
* `--after "[time]"`: Do not fetch scenes older than this period or date. Example values are: `"1 month"`, `"3 years"`, `"2019-01-01"`.
* `--scene [URL]`: Try to retrieve scene details from its official channel or network URL.
* `--deep`: Follow each release link found running `--channel` or `--network` and scrape it for more details. Enabled by default ; use `--no-deep` to only save information found on the overview pages.
#### Developers
* `--no-save`: Do not store retrieved information in local database, forcing re-fetch.
* `--level`: Change log level to `silly`, `verbose`, `info`, `warn` or `error`.
## Supported networks & sites
896 channels on 64 networks, continuously expanding!
* 21Naturals
* 21Sextreme
* 21Sextury
* Adult Time
* Amateur Allure
* Assylum
* Aziani
* Babes
* Bang!
* Bang Bros
* Blowpass
* Brazzers
* Burning Angel
* Cherry Pimps
* DDF Network
* Digital Playground
* Dogfart Network
* Evil Angel
* Fake Hub
* Fame Digital
* Fantasy Massage
* Full Porn Network
* Girlsway
* Hush Pass
* Hussie Pass
* Insex
* Interracial Pass
* JayRock Productions
* Jules Jordan
* Kelly Madison Media (Teen Fidelity)
* Kink
* LegalPorno
* Men
* Metro HD
* Mike Adriano
* Mile High Media
* MOFOS
* Naughty America
* New Sensations
* Nubiles
* Perfect Gonzo
* Perv City
* Pimp.XXX
* Porn Pros
* Private
* Pure Taboo
* Reality Kings
* SCORE
* Sexy Hub
* Team Skeet
* Teen Core Club
* Twistys
* Vivid
* Vixen
* VogoV
* Whale Member (Holed, POVD)
* Wicked
* XEmpire