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.

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

Update documentation #204

Open
5 of 6 tasks
patrickrobrecht opened this issue Feb 6, 2021 · 10 comments
Open
5 of 6 tasks

Update documentation #204

patrickrobrecht opened this issue Feb 6, 2021 · 10 comments

Comments

@patrickrobrecht
Copy link
Member

patrickrobrecht commented Feb 6, 2021

Our documentation has moved to cachify.pluginkollektiv.org.

I've updated the GitHub wiki to only link to new documentation site such that users can find the latest version.

cachify.de redirects to https://pluginkollektiv.github.io/cachify/

Methods / HDD

  • - currently we show an example Apache configuration for HTTP only sites - shouldn't be HTTPS the default in 2021?
  • - links to nginx configuration and WPTouch gist broken
  • - include how to deactivate the Apache Content Cache (instead of linking the Gist)
<IfModule mod_cache.c>
	CacheDisable /
</IfModule>
  • - remove link to nginx configuration gist, as the content is fully included on the page

FAQ

  • - links to support forum and wpSEO broken
@stklcode
Copy link
Contributor

cachify.de redirects to https://pluginkollektiv.github.io/cachify/ - can we just delete pluginkollektiv.github.io and redirect to https://cachify.pluginkollektiv.org/de/ instead?

This was done recently.
Also inline links to cachify.de have been updated in #211.

@Zodiac1978
Copy link
Member

I have done some of this in December 2021 and checked again (also changed to tasks for easier visualization of progress).

Looks like the only one is http vs https. Maybe adding https only too?

@Zodiac1978
Copy link
Member

Zodiac1978 commented Feb 20, 2022

After looking into it, it looks like that we could add one more item to "Which parts of the website are not cached by default?"
Sitemaps (see: #254 )

Correct?

@Zodiac1978
Copy link
Member

Zodiac1978 commented Feb 20, 2022

Below "Automatic clearing of the cache" there are listed some hooks:

  • After publishing new posts
  • After publishing new pages
  • After publishing new custom post types
  • After publishing new sheduled posts (only Cachify DB)
  • After updating WordPress
  • If you confirm the trash button on the adminbar
  • After saving Cachify settings

Looks like we have some more:

cachify/inc/class-cachify.php

Lines 1161 to 1174 in 2abed98

public static function register_flush_cache_hooks() {
/* Define all default flush cache hooks */
$flush_cache_hooks = array(
'cachify_flush_cache' => 10,
'_core_updated_successfully' => 10,
'switch_theme' => 10,
'before_delete_post' => 10,
'wp_trash_post' => 10,
'create_term' => 10,
'delete_term' => 10,
'edit_terms' => 10,
'user_register' => 10,
'edit_user_profile_update' => 10,
'delete_user' => 10,

Switch theme, Trash/Delete post, Create/delete/edit term, Register/update/delete user is missing.

Is there a hook firing on theme update?

@Zodiac1978
Copy link
Member

Looks like we can remove the mention of Carrington Mobile - last updates 2010. Only 100 active installations.

@Zodiac1978
Copy link
Member

We mention a special .htaccess for permalink without training slash:

A slash at the end of the permalink is also needed. For permalinks without slash at the end, the use of a special .htaccess snippets is required. The snippet code replaces the provided .htaccess entry above.

But we do not provide it. Removing the sentence or trying to provide the .htaccess?

@Zodiac1978
Copy link
Member

If you want to display the cached version of the blog pages to logged in and commenting users in WordPress, the two lines with the cookie query (RewriteCond %{HTTP_COOKIE}) must be excluded (# in front of it) in the code above.

Soll in WordPress angemeldeten und kommentierenden Nutzern ebenfalls die Cache-Version der Blogseiten angezeigt werden, müssen die beiden Zeilen mit der Cookie-Abfrage (RewriteCond %{HTTP_COOKIE}) im obigen Code einkommentiert werden (Raute davor stellen).

Shouldn't this be "auskommentiert" instead of "einkommentiert"?

https://www.wortbedeutung.info/auskommentieren/
vs.
https://www.wortbedeutung.info/404/?query=einkommentieren

@mindsolve
Copy link

Hi everyone :)

May I add another thing to the "to update" list?
I found it rather confusing that there is no mention of APC vs APCu in the documentation, only reading through issues here on GH I was able to deduct, that APC and APCu are totally different things, and that APCu is not supported (other that possibly via apcu_bc?).

Could we maybe explicitly mention the difference and requirements? For example:

APC is only available in PHP < 5.5, for later versions only the successor APCu is available, which is currently not fully supported. To be able to use APCu with Cachify, the module apcu_bc needs to be installed.

(or strike the last sentence, I didn't fully understand whether apcu_bc is a valid way based on #135)

@LukasFritzeDev
Copy link

LukasFritzeDev commented Aug 6, 2024

APC is only available in PHP < 5.5

And with Wordpress 5.2 (released in May 2019) support for PHP 5.5 and lower was officially dropped:

The minimum supported PHP version is now 5.6.20.

Maybe it would be better to simply drop support for APC (and remove the documentation), since the required PHP version is not supported anyways?

@stklcode
Copy link
Contributor

stklcode commented Aug 6, 2024

We claim “WordPress 4.7 or later“, so the first argument is rather weak.
But with the upcoming 2.4 release we require PHP 5.6 for Cachify as well, so the second part is definitely right.

I don’t care about legacy APC and I’m happy to drop the support. (update: #304)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants