[!!!][TASK] Remove deprecated constants and runtime activated packages
[Packages/TYPO3.CMS.git] / README.md
1 TYPO3 CMS
2 =========
3
4 [![Build Status](https://travis-ci.org/TYPO3/TYPO3.CMS.svg?branch=master)](https://travis-ci.org/TYPO3/TYPO3.CMS)
5
6 TYPO3 is an open source PHP based web content management system released
7 under the GNU GPL. TYPO3 is copyright (c) 1999-2020 by Kasper Skaarhoj.
8
9 This document provides a basic introduction to TYPO3.
10
11 Getting Started
12 ---------------
13
14 TYPO3 requires a web server with PHP and a database (e.g. MySQL).
15 Accessing the backend through a supported browser.
16
17 Please see the [Installation Guide](https://docs.typo3.org/installation)
18 in order to set up a basic TYPO3 installation on your web server.
19
20 What is TYPO3?
21 --------------
22
23 TYPO3 is a free and open source Content Management Framework. It is
24 released under the GNU General Public License. It can run on several web
25 servers, such as Apache, nginx or IIS, on top of many operating systems,
26 among them Linux, Microsoft Windows, FreeBSD or MacOS.
27
28 TYPO3 was initially authored by Kasper Skårhøj and is now further
29 developed by a community of contributors and the [TYPO3 Core Development
30 Team](https://typo3.org/community/teams/typo3-development/).
31
32 To get more info about the GPL license, visit
33 https://opensource.org/licenses/gpl-license
34
35 What is a Content Management Framework?
36 ---------------------------------------
37
38 A Content Management Framework is more than just a content management
39 system, due to the separation of the streamlined core and optional
40 plugins (extensions). TYPO3 has an open API that allows you to extend
41 the frontend (web site) and/or backend (administration) functionality.
42
43 The concept of extensions makes TYPO3 capable of being developed and
44 used in almost any way you can imagine, either by using any of the many
45 extensions which are available for download, or by writing your own.
46
47 TYPO3 System requirements
48 -------------------------
49
50 TYPO3 is based upon PHP and uses a database management system like
51 MySQL.
52
53 For more specific information regarding requirements see the
54 [INSTALL.md](INSTALL.md#server-system-requirements) file in this folder.
55
56 TYPO3 resources
57 ---------------
58
59 Here is an overview of the most important TYPO3 resources to help you
60 get started:
61
62 ### Get more information
63
64 * https://typo3.org is the main project website. It provides up to date
65   official news, information about events and the TYPO3 community.
66
67 * https://docs.typo3.org/: TYPO3 is one of the most thoroughly
68   documented OpenSource products around, with manuals covering basic
69   tutorials, TypoScript, administration, development, core structure,
70   etc. You should make the time to locate the various documents, and
71   read those that apply to the work you want to do.
72
73 * https://get.typo3.org/ is the platform where you can download TYPO3
74   and find all release notes and change logs of TYPO3 releases.
75
76 * https://extensions.typo3.org/ is the platform where you can search for
77   and download TYPO3 extensions.
78
79 ### Chat with us
80
81 The TYPO3 community is using a tool called Slack to openly communicate
82 with each other and with the public. Several TYPO3 teams use Slack as a
83 way to communicate internally and most channels are a welcome place for
84 you to join and get yourself involved.
85
86 * Register: https://my.typo3.org/about-mytypo3org/slack
87 * Slack: https://typo3.slack.com/
88
89 ### Exchange information, ask questions, get help
90
91 Slack is nice for short discussions, but when asking questions, most
92 answers are lost in the noise after a few minutes.
93
94 #### StackOverflow
95
96 **To let everyone profit from an answer, we recommend to ask questions
97 on StackOverflow**. If you like, you can then post a link into the
98 corresponding Slack channel to raise attention. And please, do not
99 forget to tag your questions correctly with `typo3` (and possibly other
100 tags like `typo3-9.5.x`, `Fluid` or `Extbase`).
101
102 * [StackOverflow questions tagged "TYPO3"](https://stackoverflow.com/questions/tagged/typo3)
103
104 #### Official meet the TYPO3 Community overview:
105
106 Visit https://typo3.org/community/meet/
107
108 Contributing
109 ------------
110
111 If you want to contribute to the TYPO3 source code, take a look at our
112 Contributors Walkthrough and Review System:
113
114 * https://docs.typo3.org/core-contribution
115 * https://review.typo3.org/
116
117 > Please use the [TYPO3 Slack chat](#chat-with-us), if you need help in
118 > setting up your contribution environment. The community is very
119 > helpful and get you up and running! (Please post your questions in
120 > Slack Channel `#typo3-cms-coredev` regarding contribution support)
121
122 The [repository at GitHub](https://github.com/TYPO3/TYPO3.CMS) is a
123 synchronized mirror of the primary TYPO3 core git repository:
124
125 * https://git.typo3.org/Packages/TYPO3.CMS.git
126
127 If you want to file a bug report, take a look at:
128
129 * [https://forge.typo3.org](https://forge.typo3.org/projects/typo3cms-core/issues)
130
131 Security
132 --------
133
134 If you learn about a potential security issue in the TYPO3 core or in
135 an extension, please always contact the TYPO3 Security Team via security@typo3.org.
136 Please always include the version number where you've discovered the issue.
137 If we can confirm a problem in a third-party extension, we will inform the
138 author immediately.
139
140 If you discover a security problem in your own extension, please inform
141 the TYPO3 Security Team as well. They can help you to fix it, and they
142 may want to issue an advisory once it is fixed.
143
144 For more details see [TYPO3 Security Team](https://typo3.org/community/teams/security/).
145
146 Final notes
147 -----------
148
149 TYPO3 is said to be one of the most sophisticated PHP / Internet related
150 applications available, and the more you play with it, the more you will
151 agree.
152
153 Due to the advanced level of the code and functionality, a degree of
154 study, time and perseverance is required to fully understand it, and get
155 the best from it. You should keep trying, as we say it's definitely
156 worth it. TYPO3 is the Enterprise Content Management System "for all".
157
158 The GPL license allows for developments that are based upon TYPO3 to
159 also be freely available under the GPL. Please remember this, because
160 TYPO3 is about "Inspiring People To Share". If you are making money with
161 TYPO3 you can donate or become a member of the TYPO3 Association.
162
163 By becoming a supporting member, individuals and organisations mainly
164 fund core development of TYPO3. The decision about what the funds are
165 used for, is made by all members of the Association and the Expert
166 Advisory Board (EAB). The decisions will be made transparent to the
167 community and especially the supporting members. Your funds will also
168 serve for other purposes as laid out in the bylaws.
169
170 * Donate: https://typo3.org/donate
171 * Become a member of the TYPO3 Association:
172   https://typo3.org/project/association/
173
174 Copyleft
175 --------
176
177 This document is a part of the TYPO3 project.