You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

51 lines
2.1 KiB

  1. # BSLManager
  2. A CLI is provided in the Docker image so that admins can manage their instance.
  3. ## Access to the CLI
  4. Since the CLI is packaged into the docker image, you'll have to open a shell from the container. To do so, list first your running containers:
  5. ```
  6. docker ps
  7. ```
  8. This should display you something equivalent to this:
  9. ```
  10. CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
  11. 3734c41af5a7 postgres:9.6 "docker-entrypoint.s…" 2 weeks ago Up 2 weeks 5432/tcp db_1
  12. be6870fe103e nicolasconstant/birdsitelive:latest "dotnet BirdsiteLive…" 6 weeks ago Up 2 weeks 443/tcp, 0.0.0.0:5000->80/tcp birdsitelive
  13. ```
  14. Find the BSL container and keep the ID, here it's `be6870fe103e`. And you only need the three first char to identify it, so we'll be using `be6`.
  15. Then open a shell inside the container (change `be6` with your own id):
  16. ```
  17. docker exec -it be6 /bin/bash
  18. ```
  19. And you should now be inside the container, and all you have to do is calling the CLI:
  20. ```
  21. ./BSLManager
  22. ```
  23. ## Setting up the CLI
  24. The manager will ask you to provide information about the database and the instance.
  25. Those must be same than the ones in the `docker-compose.yml` file.
  26. Provide the information, review it and validate it. Then the CLI UI should shows up.
  27. ## Using the CLI
  28. You can navigate between the sections with the arrows and tab keys.
  29. The **filter** permits to filter the list of users with a pattern.
  30. All users have their followings count provided next to them.
  31. You can select any user by using the up/down arrow keys and hitting the `Enter` key, this will display more information about the user.
  32. You can also remove a user and all their followings by hitting the `Del` key. You will be prompted by a confirmation message, and you'll be able to remove this user.
  33. Deleting users having a lots of followings can take some time: after the prompt has closed the process is still running and will update the list after that. Let the software do its thing and it will go through.