Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Config activity log as a post-installation step #2663

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+5 −0
Open

Config activity log as a post-installation step #2663

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a7e537
install_ibexa_dxp.md: Suggest to config activity log
adriendupuis Mar 7, 2025
de5b9b5
install_ibexa_dxp.md: Move "config activity log" up
adriendupuis Mar 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/getting_started/install_ibexa_dxp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,6 +396,11 @@ You should see the welcome page.

See the [Security checklist](security_checklist.md) for a list of security-related issues you should take care of before going live with a project.

### Configure recent activity log

Actions in a repository are logged in its database,
you may want to [limit this log length by enabling its automatic truncation](recent_activity.md#configuration-and-cronjob).
Copy link
Contributor

@dabrt dabrt Mar 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"you may want" gives readers an option, but you do not explain why they might want to limit the length of the log. Is there defult value that is too big? Does it cause memory issues?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we need to change the wording a bit. By default we are not truncating the log at all. The biggest problem is when the log is long overdue (milliions of records set to be deleted) on truncate the command will eat up resources rendering the site unavailable for a while. Imo if the command is implemented as it is right now, we should strongly recommend to have this cronjob set up by default.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the advice is... performance related, I would move it to the following article: Performance
where we have more such pieces of advice.

And there, I would provide a longer explanation:
"Actions in a repository are logged in its database.
When there's a large number of records and they need to be processed, it may impact the productivity of your application.
To avoid this, you may want to limit the log's length by enabling its automatic truncation after a total number of entries reaches a certain threshold."

I would also include a direct link to the "Performance" article in the installation procedure, I feel like it is missing there.


### Enable Date-based Publisher

To enable delayed publishing of Content using the Date-based Publisher, you must set up cron to run the `bin/console ibexa:scheduled:run` command periodically.
Expand Down