Skip to content

Commit 3317f58

Browse files
committed
Update URLs
1 parent 0f535f2 commit 3317f58

10 files changed

Lines changed: 35 additions & 32 deletions

docs/authentication.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Before you start, please read about Firebase Authentication in the official docu
1313
Before you can access the Firebase Realtime Database from a server using the Firebase Admin SDK,
1414
you must authenticate your server with Firebase. When you authenticate a server, rather than
1515
sign in with a user account's credentials as you would in a client app, you authenticate
16-
with a `service account <https://developers.google.com/identity/protocols/OAuth2ServiceAccount>`_
16+
with a `service account <https://developers.google.com/identity/protocols/oauth2/service-account>`_
1717
which identifies your server to Firebase.
1818

1919
You can get two different levels of access when you authenticate using the Firebase Admin SDK:
@@ -70,7 +70,7 @@ the auth / request.auth objects in your Security Rules:
7070
7171
.. note::
7272
This library uses `lcobucci/jwt <https://github.com/lcobucci/jwt>`_ to work with JSON Web Tokens (JWT).
73-
You can find the usage instructions at `https://lcobucci-jwt.readthedocs.io/ <https://lcobucci-jwt.readthedocs.io/>`_.
73+
You can find the usage instructions at https://lcobucci-jwt.readthedocs.io/.
7474

7575
.. _verify-a-firebase-id-token:
7676

@@ -124,7 +124,7 @@ Parameter Type Description
124124

125125
.. note::
126126
This library uses `lcobucci/jwt <https://github.com/lcobucci/jwt>`_ to work with JSON Web Tokens (JWT).
127-
You can find the usage instructions at `https://lcobucci-jwt.readthedocs.io/ <https://lcobucci-jwt.readthedocs.io/>`_.
127+
You can find the usage instructions at https://lcobucci-jwt.readthedocs.io/.
128128

129129

130130
***************************
@@ -217,7 +217,7 @@ Sign In with IdP credentials
217217
IdP (Identity Provider) credentials are credentials provided by authentication providers other than Firebase,
218218
for example Facebook, Github, Google or Twitter. You can find the currently supported authentication providers
219219
in the
220-
`official Firebase documentation <https://firebase.google.com/docs/projects/provisioning/configure-oauth#add-idp>`_.
220+
`official Firebase documentation <https://firebase.google.com/docs/auth/configure-oauth-rest-api#add-idp>`_.
221221

222222
This could be useful if you already have "Sign in with X" implemented in your application, and want to
223223
authenticate the same user with Firebase.
@@ -285,7 +285,7 @@ If the check fails, a ``RevokedIdToken`` exception will be thrown.
285285
by setting up Firebase Rules that check for revocation rather than using the Admin SDK to make the check.
286286

287287
For more information, please visit
288-
`Google: Detect ID token revocation in Database Rules <https://firebase.google.com/docs/auth/admin/manage-sessions#detect_id_token_revocation_in_database_rules>`_
288+
`Google: Detect ID token revocation in Database Rules <https://firebase.google.com/docs/auth/admin/manage-sessions#detect_id_token_revocation_in>`_
289289

290290
***************
291291
Session Cookies
@@ -369,15 +369,15 @@ Parameter Type Description
369369

370370
.. note::
371371
This library uses `lcobucci/jwt <https://github.com/lcobucci/jwt>`_ to work with JSON Web Tokens (JWT).
372-
You can find the usage instructions at `https://lcobucci-jwt.readthedocs.io/ <https://lcobucci-jwt.readthedocs.io/>`_.
372+
You can find the usage instructions at https://lcobucci-jwt.readthedocs.io/.
373373

374374
****************
375375
Tenant Awareness
376376
****************
377377

378378
.. note::
379379
Multi-tenancy support requires Google Cloud's Identity Platform (GCIP). To learn more about GCIP,
380-
including pricing and features, see the `GCIP documentation <https://cloud.google.com/identity-platform?hl=zh-Cn>`_.
380+
including pricing and features, see the `GCIP documentation <https://cloud.google.com/security/products/identity-platform>`_.
381381

382382
Before multi-tenancy can be used on a Google Cloud Identity Platform project, tenants must be allowed on that
383383
project via the Cloud Console UI.

docs/cloud-firestore.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ package. You can enable the component in the SDK by adding the package to your p
2121
Before you start, please read about Firestore in the official documentation:
2222

2323
- `Official Documentation <https://firebase.google.com/docs/firestore/>`_
24-
- `google/cloud-firestore on GitHub <https://github.com/googleapis/google-cloud-php-firestore>`_
25-
- `PHP API Documentation <https://googleapis.github.io/google-cloud-php/#/docs/cloud-firestore>`_
26-
- `PHP Usage Examples <https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/firestore>`_
24+
- `google/cloud-firestore on GitHub <https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/firestore>`_
25+
- `PHP API Documentation <https://cloud.google.com/php/docs/reference/cloud-storage/latest>`_
26+
- `PHP Usage Examples <https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/firestore>`_
2727

2828
************************************
2929
Initializing the Firestore component
@@ -80,4 +80,4 @@ You can add additional configuration options for the Firestore Client used by th
8080
->createFirestore();
8181
8282
You can find all configuration options in the source code of the ``FirestoreClient`` class of the
83-
`official Google Firestore PHP library <https://github.com/googleapis/google-cloud-php-firestore/blob/4186f2a2f2a8bdaedf19376a35ccb0ffad17f4e1/src/FirestoreClient.php#L138>`_.
83+
`official Google Firestore PHP library <https://github.com/googleapis/google-cloud-php-firestore/blob/eff55c22a5b2fa03a062e6735895d5549fb57631/src/FirestoreClient.php#L106>`_.

docs/cloud-messaging.rst

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Specifically, you can send messages to individual devices, named topics, or cond
1212
Before you start, please read about Firebase Cloud Messaging in the official documentation:
1313

1414
- `Introduction to Firebase Cloud Messaging <https://firebase.google.com/docs/cloud-messaging/>`_
15-
- `Introduction to Admin FCM API <https://firebase.google.com/docs/cloud-messaging/admin/>`_
15+
- `Introduction to Admin FCM API <https://firebase.google.com/docs/cloud-messaging/server-environment>`_
1616

1717
************************************
1818
Initializing the Messaging component
@@ -149,14 +149,8 @@ Send messages to specific devices
149149
*********************************
150150

151151
The Admin FCM API allows you to send messages to individual devices by specifying a registration token for the target device.
152-
Registration tokens are strings generated by the client FCM SDKs for each end-user client app instance.
153-
154-
Each of the Firebase client SDKs are able to generate these registration tokens:
155-
`iOS <https://firebase.google.com/docs/cloud-messaging/ios/client#access_the_registration_token>`_,
156-
`Android <https://firebase.google.com/docs/cloud-messaging/android/client#sample-register>`_,
157-
`Web <https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token>`_,
158-
`C++ <https://firebase.google.com/docs/cloud-messaging/cpp/client#access_the_device_registration_token>`_,
159-
and `Unity <https://firebase.google.com/docs/cloud-messaging/unity/client#initialize_firebase_messaging>`_.
152+
Registration tokens are strings `generated by the client FCM SDKs <https://firebase.google.com/docs/cloud-messaging/get-started>`_
153+
for each end-user client app instance.
160154

161155
.. code-block:: php
162156

docs/cloud-storage.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ Before you start, please read about Firebase Cloud Storage in the official docum
1212

1313
- `Firebase Cloud Storage <https://firebase.google.com/docs/storage/>`_
1414
- `Introduction to the Admin Cloud Storage API <https://firebase.google.com/docs/storage/admin/start>`_
15-
- `PHP API Documentation <https://googleapis.github.io/google-cloud-php/#/docs/cloud-storage>`_
16-
- `PHP Usage examples <https://github.com/GoogleCloudPlatform/php-docs-samples/blob/master/storage>`_
15+
- `PHP API Documentation <https://cloud.google.com/php/docs/reference/cloud-storage/latest>`_
16+
- `PHP Usage examples <https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/storage>`_
1717

1818
**********************************
1919
Initializing the Storage component

docs/conf.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,3 +97,12 @@
9797
lexers['php'] = PhpLexer(startinline=True, linenos=1)
9898
lexers['php-annotations'] = PhpLexer(startinline=True, linenos=1)
9999

100+
# Link check
101+
linkcheck_allowed_redirects = {
102+
r'https://console\.developers\.google\.com.*': r'https://accounts\.google\.com.*',
103+
r'https://console\.firebase\.google\.com.*': r'https://accounts\.google\.com.*',
104+
r'https://.+\.readthedocs\.io.+': r'https://.+\.readthedocs\.io.+',
105+
r'https://stackoverflow\.com/a.+': r'https://stackoverflow\.com/questions.+',
106+
}
107+
linkcheck_anchors = False
108+

docs/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ privileged environments (such as servers or cloud) in PHP.
4343
Installation
4444
************
4545

46-
The recommended way to install the Firebase Admin SDK is with `Composer <http://getcomposer.org>`_.
46+
The recommended way to install the Firebase Admin SDK is with `Composer <https://getcomposer.org>`_.
4747
Composer is a dependency management tool for PHP that allows you to declare the dependencies
4848
your project needs and installs them into your project.
4949

@@ -81,7 +81,7 @@ Quick Start
8181
License
8282
*******
8383

84-
Licensed using the `MIT license <http://opensource.org/licenses/MIT>`_.
84+
Licensed using the `MIT license <https://opensource.org/license/MIT>`_.
8585

8686
Copyright (c) Jérôme Gamez <https://github.com/jeromegamez> <jerome@gamez.name>
8787

docs/remote-config.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ List versions
233233
-------------
234234

235235
To enhance performance and prevent memory issues when retrieving a huge amount of versions,
236-
this methods returns a `Generator <http://php.net/manual/en/language.generators.overview.php>`_.
236+
this methods returns a `Generator <https://www.php.net/manual/en/language.generators.overview.php>`_.
237237

238238
.. code-block:: php
239239

docs/setup.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Google Service Account
99
**********************
1010

1111
In order to access a Firebase project using a server SDK, you must authenticate your requests to Firebase with
12-
`Service Account credentials <https://developers.google.com/identity/protocols/OAuth2ServiceAccount>`_.
12+
`Service Account credentials <https://developers.google.com/identity/protocols/oauth2/service-account>`_.
1313

1414
The SDK is able to auto-discover the Service Account for your project in the following conditions:
1515

docs/troubleshooting.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ You are probably not using the latest release of the SDK, please update your com
105105
Call to undefined function ``openssl_sign()``
106106
*********************************************
107107

108-
You need to install the OpenSSL PHP Extension: http://php.net/openssl
108+
You need to install the OpenSSL PHP Extension: https://www.php.net/openssl
109109

110110
********************************************
111111
Default sound not played on message delivery
@@ -154,7 +154,7 @@ which should lead to an output similar to this:
154154
155155
Now check if the file given in the ``default_cert_file`` field actually exists.
156156
Create a backup of the file, download the current CA bundle from
157-
https://curl.haxx.se/ca/cacert.pem and put it where ``default_cert_file``
157+
https://curl.se/ca/cacert.pem and put it where ``default_cert_file``
158158
points to.
159159

160160
If the problem still occurs, another possible solution is to configure the ``curl.cainfo``
@@ -205,7 +205,7 @@ code:
205205
206206
echo curl_version()['version']; exit;
207207
208-
To install a newer version of cURL, download the latest release from https://curl.haxx.se/ . From
208+
To install a newer version of cURL, download the latest release from https://curl.se/. From
209209
the unpacked archive in the ``bin`` folder, use the file ending with ``libcurl*.dll`` to overwrite
210210
the existing ``libcurl*.dll`` in the ``ext`` folder of your PHP installation and restart the
211211
environment.

docs/user-management.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ List users
5151
**********
5252

5353
To enhance performance and prevent memory issues when retrieving a huge amount of users,
54-
this methods returns a `Generator <http://php.net/manual/en/language.generators.overview.php>`_.
54+
this methods returns a `Generator <https://www.php.net/manual/en/language.generators.overview.php>`_.
5555

5656
.. code-block:: php
5757
@@ -388,7 +388,7 @@ Custom user claims
388388
// Remove a user's custom claims
389389
$auth->setCustomUserClaims($uid, null);
390390
391-
The custom claims object should not contain any `OIDC <http://openid.net/specs/openid-connect-core-1_0.html#IDToken>`_
391+
The custom claims object should not contain any `OIDC <https://openid.net/specs/openid-connect-core-1_0.html#IDToken>`_
392392
reserved key names or Firebase reserved names. Custom claims payload must not exceed 1000 bytes.
393393

394394
*************
@@ -525,7 +525,7 @@ when it is installed or from a browser.
525525

526526
For links that are meant to be opened via a mobile app, you’ll need to enable Firebase Dynamic Links and perform some
527527
tasks to detect these links from your mobile app. Refer to the instructions on how to
528-
`configure Firebase Dynamic Links <https://firebase.google.com/docs/auth/web/passing-state-in-email-actions#configuring_firebase_dynamic_links>`_
528+
`configure Firebase Dynamic Links <https://firebase.google.com/docs/auth/web/passing-state-in-email-actions#configuring-hosting-links>`_
529529
for email actions.
530530

531531
========================= =========== ===========

0 commit comments

Comments
 (0)