From d48778838e25f73cd48d5e0124bf0da74af33163 Mon Sep 17 00:00:00 2001 From: Cullen Date: Sat, 19 Aug 2023 20:37:49 -0500 Subject: [PATCH] docs: update README.md --- README.md | 34 ++++++++++++++-------------------- 1 file changed, 14 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 9b348bf..0b370e4 100644 --- a/README.md +++ b/README.md @@ -25,17 +25,6 @@ - **results_wanted**: int - **easy_apply**: bool (Only for LinkedIn) -## .env for auth - -The auth uses [supabase](https://supabase.com). Create a project with a `users` table and disable RLS. - - -Add these two environment variables: - -- `SUPABASE_URL`: go to project settings -> API -> Project URL -- `SUPABASE_KEY`: go to project settings -> API -> service_role secret -- `JWT_SECRET_KEY` - type `openssl rand -hex 32` in terminal to create a 32 byte secret key - ## Installation _Python >= 3.10 required_ 1. Clone this repository @@ -49,15 +38,20 @@ Visit [http://localhost:8000/docs](http://localhost:8000/docs) to see the intera ## FAQ -### I'm getting a 404 error when querying LinkedIn. What can I do? - -LinkedIn's API is generally more strict. If you encounter a 404 error, try reducing the `results_wanted` parameter. There may not be enough results. - ### I'm having issues with my queries. What should I do? -Broadening your filters can often help. For instance, if you're using very specific criteria, try making them more general to retrieve results more reliably. If it still persists, submit an issue. +Broadening your filters can often help. Additionally, try reducing the number of `results_wanted`. +If issues still persist, feel free to submit an issue. -### How to remove auth (no .env)? -Remove this part from `api/v1/__init__.py` - -![image](https://github.com/cullenwatson/jobspy/assets/78247585/383ca172-cc36-4f89-b26d-c25d9c67bea7) +### How to enable auth? + +Change `AUTH_REQUIRED` in `/settings.py` to `True` + +The auth uses [supabase](https://supabase.com). Create a project with a `users` table and disable RLS. + + +Add these three environment variables: + +- `SUPABASE_URL`: go to project settings -> API -> Project URL +- `SUPABASE_KEY`: go to project settings -> API -> service_role secret +- `JWT_SECRET_KEY` - type `openssl rand -hex 32` in terminal to create a 32 byte secret key