- Node.js with npm or npx
- PostgreSQL (for storing posts, other DBs soon)
- Redis (for storing captchas)
- ffmpeg (for processing videos metadata)
- [NPM] sharp (for processing images and previews)
- [NPM] canvas (for creating captcha images) (there is an issue on Windows, please, use Docker version)
- [optional] [NPM] node-static (if web server like nginx is not used)
git clone https://github.com/BakaSolutions/foxtan
cd foxtan
# Install using pnpm (https://pnpm.io)
pnpm install
After you have installed the dependencies, config.js file will get automatically created for you. Edit it to set up the engine.
Once engine set up is done, run knex migrate:latest to create tables in your database.
Run knex seed:run to add default admin account and some post samples.
Default admin credentials:
- login:
admin - password:
changeme
# Launch on LTS or "current" version
node app # or `pnpm start`
# Launch on non-LTS
npx -p node@lts -- node app
To learn more about the API, check out fkclient.js as well as its example - the simplest application based on Foxtan API.