Femboy Fans

• Latest version of Docker (download).
• Latest version of Docker Compose (download)
• Git (download)

If you are on Windows Docker Compose is already included, you do not need to install it yourself. If you are on Linux/MacOS you can probably use your package manager.

1. Download and install the prerequisites.
2. Clone the repo with git clone https://github.com/FemboyFans/FemboyFans.git.
3. cd into the repo.
4. Copy the sample environment file with cp .env.sample .env.
5. Run the following commands:

   docker compose run --rm --no-deps femboyfans /app/bin/presetup
   docker compose run --rm -e SEED_POST_COUNT=100 femboyfans /app/bin/setup
   docker compose run --rm reports npm run migrate
   docker compose up
   

   After running the commands once only docker compose up is needed to bring up the containers.
6. To confirm the installation worked, open the web browser of your choice and enter http://localhost:3001 into the address bar and see if the website loads correctly. Create an account via http://localhost:3001/users/new. The first created user will automatically be promoted to the "Owner" level.

Note: When gems or js packages are updated you need to execute docker compose build to reflect them in the container.

Try this:

1. docker compose down -v to remove all volumes.
2. docker compose build --no-cache to rebuild the image from scratch.
3. Follow the instructions starting from step 5.

You're most likely using Windows. Give this a shot, it tells Git to stop tracking file mode changes:

git config core.fileMode false

docker compose run --rm tests to execute the test suite.

docker compose run --rm rubocop to run the linter.

The postgres server accepts outside connections which you can use to access it with a local client. Use localhost:34518 to connect to a database named femboyfans_development with the user femboyfans. Leave the password blank, anything will work.

Installation follows the same steps as the docker compose file. Ubuntu 20.04 is the current installation target. There is no script that performs these steps for you, as you need to split them up to match your infrastructure. Running a single machine install in production is possible, but is likely to be somewhat sluggish due to contention in disk between postgresql and opensearch. Minimum RAM is 4GB. You will need to adjust values in config files to match how much RAM is available. If you are targeting more than a hundred thousand posts and reasonable user volumes, you probably want to procure yourself a database server. See tuning guides for postgresql and opensearch for help planning these requirements.

These wik/help pages are expected to exist, as they are linked to or used in various places.

• help:contact
• help:home
• help:privacy_policy
• help:staff
• help:takedown
• help:takedown_verification
• help:terms_of_service
• internal:rules_body
• internal:flag_notice
• internal:replacement_notice
• howto:sites_and_sources
• howto:tag_genders

• accounts
• api
• artists
• avoid_posting
• blacklisting
• blocking
• cheatsheet
• commenting
• dmails
• flagging
• forums
• global_blacklist
• modqueue
• notes
• pools
• post_relationships
• posts
• privacy_policy
• replacements
• reporting
• sets
• staff
• tag_aliases
• tag_implications
• tagging_checklist
• tags
• terms_of_service
• uploading
• upload_whitelist
• uploading_guidelines
• user_name_change_requests
• wiki

These instructions won't work for everyone. If your setup is not working, here are the steps I usually recommend to people:

1. Test the database. Make sure you can connect to it using psql. Make sure the tables exist. If this fails, you need to work on correctly installing PostgreSQL, importing the initial schema, and running the migrations.

2. Test the Rails database connection by using rails console. Run Post.count to make sure Rails can connect to the database. If this fails, you need to make sure your configuration files are correct.

3. Test Nginx to make sure it's working correctly. You may need to debug your Nginx configuration file.

4. Check all log files.

To have recommendations, a user must have at least 50 favorites. A post must have at least 5 favorites to have recommendations. There are some scripts in db/seeds to generate both users and favorites.

To train the model, simply run: docker compose run --rm recommender python -m poetry run python train