traxxx/README.md

117 lines
3.9 KiB
Markdown
Raw Normal View History

2019-03-02 22:59:15 +00:00
# Traxxx
2019-04-08 02:07:39 +00:00
**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`
2019-04-08 01:34:28 +00:00
### 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/`.
`npm run migrate`
`npm run seed`
`npm start`
### 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`.
### Options
2019-04-08 01:34:28 +00:00
`npm start -- --option value`
2020-04-11 20:49:37 +00:00
* `--server`: Run the web server
* `--fetch`: Fetch updates instead of running the webserver. Without further arguments, it will use the networks and sites defined in the configuration file.
2019-09-22 17:32:10 +00:00
* `--site [site ID]`: Fetch updates from a specific site. The site ID is typically the site name in lowercase and without cases or special characters. For example, Teens Like It Big is teenslikeitbig.
* `--network [network ID]`: Fetch updates from all sites of a specific network. The network ID is composed similarly to the site ID.
* `--after "[time]"`: Do not fetch scenes older than this. Example values are: `"1 month"`, `"2 weeks"`, `"3 years"`.
* `--scene [URL]`: Try to retrieve scene details from its official site or network URL.
2019-09-22 17:32:10 +00:00
* `--deep`: Follow each release link found running `--site` or `--network` and scrape it for more details. Enabled by default at the moment of writing; use `--no-deep` to only save information found on the overview pages.
* `--copy`: Try to copy relevant results to the clipboard. When used with `--scene`, it will copy the filename as defined in the config with all the details filled in.
2020-04-11 20:49:37 +00:00
## Developers
### Options
* `--no-save`: Do not store retrieved information in local database, forcing re-fetch.
* `--debug`: Show full error stack trace.
2020-04-11 20:49:37 +00:00
### Generating thumbnails
Ensure each tag or sfw category directory has a `thumbs` and `lazy` directory: `for dir in \*; do mkdir "$dir/thumbs $dir/lazy"; done`
Using ImageMagick's bulk tool `mogrify` to generate 240px thumbnails and 90px lazy pre-loading images:
* Generate thumbnails within tag or sfw directory: `mogrify -path lazy -resize x240 -quality 90% \*.jpeg`
* Generate lazy loading images within tag or sfw directory: `mogrify -path lazy -resize x90 -quality 90% \*.jpeg`
* Generate thumbnails for all tags or categories in `tags` or `sfw` directory: `for dir in \*; do mogrify -path "$dir/thumbs" -resize x240 -quality 90% "$dir/\*.jpeg"; done`
* Generate lazy loading images for all tags categories in `tags` or `sfw` directory: `for dir in \*; do mogrify -path "$dir/lazy" -resize x90 -quality 90% "$dir/\*.jpeg"; done`
## Supported networks & sites
768 sites on 62 networks, continuously expanding!
2019-04-08 02:07:39 +00:00
* 21Naturals
* 21Sextreme
* 21Sextury
* Adult Time
* Amateur Allure
* Assylum
* Aziani
* Babes
* BAM Visions
* 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
* Gamma Entertainment
* Girlsway
* Hush
* Hush Pass
* Hussie Pass
* Insex
* Interracial Pass
* JayRock Productions
* Jesse Loads Monster Facials
* Jules Jordan
* Kelly Madison Media
* Kink
* LegalPorno
* Men
* Metro HD
* Mike Adriano
* Mile High Media
* Mind Geek
* MOFOS
* Naughty America
* New Sensations
* Nubiles
* Perfect Gonzo
* Perv City
* Pimp.XXX
* Porn Pros
* Private
* Pure Taboo
* Reality Kings
* SCORE
* Sexy Hub
* Team Skeet
* Twistys
* Vivid
* Vixen
* VogoV
* Whale Member
* Wicked
* XEmpire